# iSubRip
A Python package for scraping and downloading subtitles from AppleTV / iTunes movie pages.
Latest version: 2.5.4 ([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://python.org/pypi/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://github-production-user-asset-6210df.s3.amazonaws.com/8832013/290989935-e6a17af6-1ebb-456d-a024-dc6e84dd64b2.gif" width="800"></a>
</p>
## Requirements
* Python 3.8+
## Installation
### PyPI (Recommended)
```
python3 -m pip install isubrip
```
### Git Source Code
```
python3 -m pip install -e git+https://github.com/MichaelYochpaz/iSubRip.git#egg=isubrip
```
## Usage
```
isubrip <iTunes movie URL> [iTunes movie URL...]
```
## Configuration
A [TOML](https://toml.io) config file can be created and used to configure different options and features.
A config file will be looked for in one of the following paths (according to OS):
**Windows**: `%USERPROFILE%\.isubrip\config.toml`
**Linux / macOS**: `$HOME/.isubrip/config.toml`
### Examples:
**Windows**: `C:\Users\Michael\.isubrip\config.toml`
**Linux**: `/home/Michael/.isubrip/config.toml`
**macOS**: `/Users/Michael/.isubrip/config.toml`
---
### Example Config:
```toml
[downloads]
folder = "C:\\Subtitles\\iTunes"
languages = ["en-US", "fr-FR", "he"]
zip = false
[subtitles]
convert-to-srt = true
fix-rtl = true
[subtitles.webvtt]
subrip-alignment-conversion = true
```
An example config with details and explanations for all available settings can be found [here](https://github.com/MichaelYochpaz/iSubRip/blob/main/config.toml).
## Logs
A log file, containing debug information, will be created for each run on one of the following paths (according to OS):
**Windows**: `%USERPROFILE%\.isubrip\logs`
**Linux / macOS**: `$HOME/.isubrip/logs`
Log rotation (deletion of old files, once a certain amount of files is reached) can be configured in the config file using the `general.log-rotation-size` setting. The default log rotation value is `15`.
Raw data
{
"_id": null,
"home_page": "https://github.com/MichaelYochpaz/iSubRip",
"name": "isubrip",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "iTunes, AppleTV, movies, subtitles, scrape, scraper, download, m3u8",
"author": "Michael Yochpaz",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b7/8e/585f443a9449285dd668a4a897ba3a39d9ac4df5c55387f97af83ae7b0ba/isubrip-2.5.4.tar.gz",
"platform": null,
"description": "# iSubRip\nA Python package for scraping and downloading subtitles from AppleTV / iTunes movie pages. \nLatest version: 2.5.4 ([changelog](https://github.com/MichaelYochpaz/iSubRip/blob/main/CHANGELOG.md)) \n\n<br/>\n \n[![PyPI - Version](https://img.shields.io/pypi/v/isubrip)](https://python.org/pypi/isubrip)\n[![PyPI - Monthly Downloads](https://pepy.tech/badge/isubrip/month)](https://python.org/pypi/isubrip)\n[![PyPI - Total Downloads](https://pepy.tech/badge/isubrip)](https://python.org/pypi/isubrip)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/isubrip)](https://python.org/pypi/isubrip)\n[![GitHub - License](https://img.shields.io/github/license/MichaelYochpaz/iSubRip)](https://github.com/MichaelYochpaz/iSubRip/blob/main/LICENSE)\n[![GitHub - issues](https://img.shields.io/github/issues/MichaelYochpaz/iSubRip)](https://github.com/MichaelYochpaz/iSubRip/issues)\n[![GitHub - Repo stars](https://img.shields.io/github/stars/MichaelYochpaz/iSubRip.svg?color=yellow)](https://github.com/MichaelYochpaz/iSubRip)\n\n<p align=\"center\">\n <a href=\"#\"><img src=\"https://github-production-user-asset-6210df.s3.amazonaws.com/8832013/290989935-e6a17af6-1ebb-456d-a024-dc6e84dd64b2.gif\" width=\"800\"></a>\n</p>\n\n\n## Requirements\n* Python 3.8+\n\n## Installation\n### PyPI (Recommended)\n```\npython3 -m pip install isubrip\n```\n\n### Git Source Code\n```\npython3 -m pip install -e git+https://github.com/MichaelYochpaz/iSubRip.git#egg=isubrip\n```\n\n## Usage\n```\nisubrip <iTunes movie URL> [iTunes movie URL...]\n``` \n\n## Configuration\nA [TOML](https://toml.io) config file can be created and used to configure different options and features.\nA config file will be looked for in one of the following paths (according to OS): \n\n**Windows**: `%USERPROFILE%\\.isubrip\\config.toml` \n**Linux / macOS**: `$HOME/.isubrip/config.toml` \n\n### Examples:\n**Windows**: `C:\\Users\\Michael\\.isubrip\\config.toml` \n**Linux**: `/home/Michael/.isubrip/config.toml` \n**macOS**: `/Users/Michael/.isubrip/config.toml` \n\n---\n\n### Example Config:\n```toml\n[downloads]\nfolder = \"C:\\\\Subtitles\\\\iTunes\"\nlanguages = [\"en-US\", \"fr-FR\", \"he\"]\nzip = false\n\n[subtitles]\nconvert-to-srt = true\nfix-rtl = true\n\n[subtitles.webvtt]\nsubrip-alignment-conversion = true\n```\n\nAn example config with details and explanations for all available settings can be found [here](https://github.com/MichaelYochpaz/iSubRip/blob/main/config.toml).\n\n## Logs\nA log file, containing debug information, will be created for each run on one of the following paths (according to OS):\n\n**Windows**: `%USERPROFILE%\\.isubrip\\logs` \n**Linux / macOS**: `$HOME/.isubrip/logs` \n\nLog rotation (deletion of old files, once a certain amount of files is reached) can be configured in the config file using the `general.log-rotation-size` setting. The default log rotation value is `15`.",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python package for scraping and downloading subtitles from AppleTV / iTunes movie pages.",
"version": "2.5.4",
"project_urls": {
"Bug Reports": "https://github.com/MichaelYochpaz/iSubRip/issues",
"Homepage": "https://github.com/MichaelYochpaz/iSubRip",
"Repository": "https://github.com/MichaelYochpaz/iSubRip"
},
"split_keywords": [
"itunes",
" appletv",
" movies",
" subtitles",
" scrape",
" scraper",
" download",
" m3u8"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9ed4d5e231e73a99f0734dcabdce2fd64c35a04503ecdf012d6560a0ae59f3e",
"md5": "9a256bb2dcbae8a41f4da60c62c39fe3",
"sha256": "ef04060621dc7174d7ccb12c02524abc455e8df12df1d5d696f482c22a72d453"
},
"downloads": -1,
"filename": "isubrip-2.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a256bb2dcbae8a41f4da60c62c39fe3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 43762,
"upload_time": "2024-04-28T16:32:55",
"upload_time_iso_8601": "2024-04-28T16:32:55.796537Z",
"url": "https://files.pythonhosted.org/packages/b9/ed/4d5e231e73a99f0734dcabdce2fd64c35a04503ecdf012d6560a0ae59f3e/isubrip-2.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b78e585f443a9449285dd668a4a897ba3a39d9ac4df5c55387f97af83ae7b0ba",
"md5": "d2aa8d51601bb78a279edae66e8912f0",
"sha256": "38d341360e5d0be5005b377152e1e0a22eb8d2289e2b0c96fafc8ccc80840ff8"
},
"downloads": -1,
"filename": "isubrip-2.5.4.tar.gz",
"has_sig": false,
"md5_digest": "d2aa8d51601bb78a279edae66e8912f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 35555,
"upload_time": "2024-04-28T16:32:57",
"upload_time_iso_8601": "2024-04-28T16:32:57.597495Z",
"url": "https://files.pythonhosted.org/packages/b7/8e/585f443a9449285dd668a4a897ba3a39d9ac4df5c55387f97af83ae7b0ba/isubrip-2.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 16:32:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MichaelYochpaz",
"github_project": "iSubRip",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "isubrip"
}