yt-dlpp


Nameyt-dlpp JSON
Version 1.0.2 PyPI version JSON
download
home_pageNone
SummaryA thin wrapper around yt-dlp for parallel downloads
upload_time2024-05-27 23:07:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseThis is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, please refer to <https://unlicense.org>
keywords download yt-dlp video audio parallel
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # yt-dlpp
A thin wrapper around [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) for parallel downloads

## Description

`yt-dlpp` is just `yt-dlp` but starts downloads in parallel.   
It supports passing multiple download URLs and unwrapping playlists.

## Installation

Note: In addition to `yt-dlpp`, it is expected that you also have a valid `yt-dlp` install available in the command line.  
Only Linux has been tested and validated, but feel free to open a PR to add support for other OS-es. 

### From pypi

```sh
pip install yt-dlpp
```


### From source, on Linux

```sh
git clone https://github.com/GeoffreyCoulaud/yt-dlpp.git
cd yt-dlpp
python3 -m venv .venv
source .venv/bin/activate
pip install
```

## Usage

`yt-dlpp` accepts all valid `yt-dlp` arguments and passes them mostly intact.  
However, arguments related to CLI output will be ignored since that is handled by `yt-dlpp`.

Below, you can find a short list of the added arguments:

| Argument | Description | Default value |
| - | - | - |
| `--n-info-workers` | Number concurrent url info extraction workers | Number of CPUs in the system |
| `--n-dl-workers` | Number concurrent download workers | Number of CPUs in the system |

## Architecture

`yt-dlpp` spreads the info getting and downloads to multiple worker processes. Here is an architecture overview of the project :

```mermaid
graph TD
    A[CLI Entry Point]-->B[Info Worker 1]
    A-->C[Info Worker 2]
    A-->D[...]
    A-->E[Info Worker N]
    B-->F[Download Deduplication Worker]
	C-->F
	D-->F
	E-->F
	F-->G[Download Worker 1]
	F-->H[Download Worker 2]
	F-->I[...]
	F-->J[Download Worker N]
	G-->K[Progress Display Worker]
	H-->K
	I-->K
	J-->K

```

## Reason to exist

As you may be aware, starting multiple Youtube downloads in parallel will probably not change the overall time taken, since a rate limit is in place, and before reaching it, you may simply reach your ISP's limit.  
But `yt-dlp` (and therefore `yt-dlpp` too) is not only used for Youtube! Other websites have different restrictions, and some may simply allow downloads at a slow speed, but no per IP throttling (eg. NHK World Japan).


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "yt-dlpp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "download, yt-dlp, video, audio, parallel",
    "author": null,
    "author_email": "Geoffrey Coulaud <geoffrey.coulaud@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/81/b3/675f823e26082c2a6a5b98da64136ca01700b9d42851c02fb63a06527414/yt_dlpp-1.0.2.tar.gz",
    "platform": null,
    "description": "# yt-dlpp\nA thin wrapper around [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) for parallel downloads\n\n## Description\n\n`yt-dlpp` is just `yt-dlp` but starts downloads in parallel.   \nIt supports passing multiple download URLs and unwrapping playlists.\n\n## Installation\n\nNote: In addition to `yt-dlpp`, it is expected that you also have a valid `yt-dlp` install available in the command line.  \nOnly Linux has been tested and validated, but feel free to open a PR to add support for other OS-es. \n\n### From pypi\n\n```sh\npip install yt-dlpp\n```\n\n\n### From source, on Linux\n\n```sh\ngit clone https://github.com/GeoffreyCoulaud/yt-dlpp.git\ncd yt-dlpp\npython3 -m venv .venv\nsource .venv/bin/activate\npip install\n```\n\n## Usage\n\n`yt-dlpp` accepts all valid `yt-dlp` arguments and passes them mostly intact.  \nHowever, arguments related to CLI output will be ignored since that is handled by `yt-dlpp`.\n\nBelow, you can find a short list of the added arguments:\n\n| Argument | Description | Default value |\n| - | - | - |\n| `--n-info-workers` | Number concurrent url info extraction workers | Number of CPUs in the system |\n| `--n-dl-workers` | Number concurrent download workers | Number of CPUs in the system |\n\n## Architecture\n\n`yt-dlpp` spreads the info getting and downloads to multiple worker processes. Here is an architecture overview of the project :\n\n```mermaid\ngraph TD\n    A[CLI Entry Point]-->B[Info Worker 1]\n    A-->C[Info Worker 2]\n    A-->D[...]\n    A-->E[Info Worker N]\n    B-->F[Download Deduplication Worker]\n\tC-->F\n\tD-->F\n\tE-->F\n\tF-->G[Download Worker 1]\n\tF-->H[Download Worker 2]\n\tF-->I[...]\n\tF-->J[Download Worker N]\n\tG-->K[Progress Display Worker]\n\tH-->K\n\tI-->K\n\tJ-->K\n\n```\n\n## Reason to exist\n\nAs you may be aware, starting multiple Youtube downloads in parallel will probably not change the overall time taken, since a rate limit is in place, and before reaching it, you may simply reach your ISP's limit.  \nBut `yt-dlp` (and therefore `yt-dlpp` too) is not only used for Youtube! Other websites have different restrictions, and some may simply allow downloads at a slow speed, but no per IP throttling (eg. NHK World Japan).\n\n",
    "bugtrack_url": null,
    "license": "This is free and unencumbered software released into the public domain.  Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.  In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  For more information, please refer to <https://unlicense.org> ",
    "summary": "A thin wrapper around yt-dlp for parallel downloads",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/GeoffreyCoulaud/yt-dlpp",
        "Repository": "https://github.com/GeoffreyCoulaud/yt-dlpp.git"
    },
    "split_keywords": [
        "download",
        " yt-dlp",
        " video",
        " audio",
        " parallel"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7b9b62bec42292e14cdacf9721f12605ee5d89f23e3a14135a00342a14e640be",
                "md5": "72e918569fbba5a351d9cfa6ce1c5bf3",
                "sha256": "11f5eb05ce19daf020684323c67466cc7c1f26c4243a3608720ccb056c5647b0"
            },
            "downloads": -1,
            "filename": "yt_dlpp-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "72e918569fbba5a351d9cfa6ce1c5bf3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 12841,
            "upload_time": "2024-05-27T23:07:19",
            "upload_time_iso_8601": "2024-05-27T23:07:19.400324Z",
            "url": "https://files.pythonhosted.org/packages/7b/9b/62bec42292e14cdacf9721f12605ee5d89f23e3a14135a00342a14e640be/yt_dlpp-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81b3675f823e26082c2a6a5b98da64136ca01700b9d42851c02fb63a06527414",
                "md5": "3d4b1e57d2c764bae0cdaeecd2fc6b31",
                "sha256": "f6ffb130cb11c9be716e45a9d3f7b0380fcb766071c82b2f45b52d53eeca00be"
            },
            "downloads": -1,
            "filename": "yt_dlpp-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "3d4b1e57d2c764bae0cdaeecd2fc6b31",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 11383,
            "upload_time": "2024-05-27T23:07:20",
            "upload_time_iso_8601": "2024-05-27T23:07:20.999835Z",
            "url": "https://files.pythonhosted.org/packages/81/b3/675f823e26082c2a6a5b98da64136ca01700b9d42851c02fb63a06527414/yt_dlpp-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-27 23:07:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GeoffreyCoulaud",
    "github_project": "yt-dlpp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "yt-dlpp"
}
        
Elapsed time: 0.29185s