Metadata-Version: 2.1
Name: isubrip
Version: 2.1.2
Summary: A Python package for scraping and downloading subtitles from iTunes movie pages.
Home-page: https://github.com/MichaelYochpaz/iSubRip
Author: Michael Yochpaz
License: MIT
Project-URL: Bug Reports, https://github.com/MichaelYochpaz/iSubRip/issues
Project-URL: Source, https://github.com/MichaelYochpaz/iSubRip
Keywords: iTunes,movies,subtitles,scrape,scraper,download,m3u8
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# iSubRip
A Python package for scraping and downloading subtitles from iTunes movie pages.  
Latest version: 2.1.2 ([changelog](https://github.com/MichaelYochpaz/iSubRip/blob/main/CHANGELOG.md))  

<br/>
  
[![PyPI - Version](https://img.shields.io/pypi/v/isubrip)](https://python.org/pypi/isubrip)
[![PyPI - Monthly Downloads](https://pepy.tech/badge/isubrip/month)](https://pepy.tech/project/isubrip)
[![PyPI - Total Downloads](https://pepy.tech/badge/isubrip)](https://python.org/pypi/isubrip)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/isubrip)](https://python.org/pypi/isubrip)
[![GitHub - License](https://img.shields.io/github/license/MichaelYochpaz/iSubRip)](https://github.com/MichaelYochpaz/iSubRip/blob/main/LICENSE)
[![GitHub - issues](https://img.shields.io/github/issues/MichaelYochpaz/iSubRip)](https://github.com/MichaelYochpaz/iSubRip/issues)
[![GitHub - Repo stars](https://img.shields.io/github/stars/MichaelYochpaz/iSubRip.svg?color=yellow)](https://github.com/MichaelYochpaz/iSubRip)
  
<p align="center">
  <a href="#"><img src="https://user-images.githubusercontent.com/8832013/151677574-0539aa8b-7f88-4ae8-a85d-948c5338c873.png" width="800"></a>
</p>


##  Requirements
* Python 3.6+
* [FFmpeg](https://github.com/FFmpeg/FFmpeg) (If FFmpeg is not set in [PATH](https://en.wikipedia.org/wiki/PATH_(variable)), use a config file to set its path.)

##  Installation
### pip:
```
pip3 install isubrip
```

## Usage
Usage: ```isubrip <iTunes movie URL> [iTunes movie URL...]```  

## Configuration
For settings configuration, a [TOML](https://toml.io) config file can be used.  
It allows configuring settings like download path, which lanaguages to download, and which file format to use (WebVTT / SRT).  

The file should be place in one of the following paths (according to OS): 

**Windows**: ```%AppData%/iSubRip/config.toml```  
**Linux**: ```$XDG_CONFIG_HOME/iSubRip/config.toml```  
**MacOS**: ```~/Library/Application Support/isubrip/config.toml```  

An example config file with all the available options can be found [here](https://github.com/MichaelYochpaz/iSubRip/blob/main/config.toml)

### Notes
* All settings are optional. Not specifying a setting will result in using the default value (set in the `default.toml` file).

* If running on a Linux machine and XDG_CONFIG_HOME is not set, it's value will default to `~/.config`.


