{"id":13448257,"url":"https://github.com/pyload/pyload","last_synced_at":"2025-05-14T09:06:15.641Z","repository":{"id":6873729,"uuid":"8122790","full_name":"pyload/pyload","owner":"pyload","description":"The free and open-source Download Manager written in pure Python","archived":false,"fork":false,"pushed_at":"2025-05-10T20:30:32.000Z","size":49415,"stargazers_count":3492,"open_issues_count":223,"forks_count":724,"subscribers_count":124,"default_branch":"develop","last_synced_at":"2025-05-14T09:02:40.433Z","etag":null,"topics":["cyberlocker","ddl","debrid","download","downloader","downloadmanager","flashgot","headless","jdownloader","linkdecrypter","pyload","pypi","python","qnap","raspberry-pi","synology","webui"],"latest_commit_sha":null,"homepage":"https://pyload.net","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyload.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":["https://PayPal.Me/nitzo2001/0usd"]}},"created_at":"2013-02-10T13:12:02.000Z","updated_at":"2025-05-12T14:15:45.000Z","dependencies_parsed_at":"2023-10-26T17:30:22.502Z","dependency_job_id":"35895b28-aff1-4f12-a84c-b76412871dbd","html_url":"https://github.com/pyload/pyload","commit_stats":{"total_commits":7208,"total_committers":228,"mean_commits":"31.614035087719298","dds":0.7746947835738069,"last_synced_commit":"0a3a278b640e3910caba2ec5719ca5dcb0831abe"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyload%2Fpyload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyload%2Fpyload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyload%2Fpyload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyload%2Fpyload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyload","download_url":"https://codeload.github.com/pyload/pyload/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254110373,"owners_count":22016391,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cyberlocker","ddl","debrid","download","downloader","downloadmanager","flashgot","headless","jdownloader","linkdecrypter","pyload","pypi","python","qnap","raspberry-pi","synology","webui"],"created_at":"2024-07-31T05:01:40.235Z","updated_at":"2025-05-14T09:06:15.616Z","avatar_url":"https://github.com/pyload.png","language":"Python","readme":"\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/pyload/pyload/main/media/banner.png\" alt=\"pyLoad\" height=\"110\" /\u003e\n\u003c/p\u003e\n\u003ch2 align=\"center\"\u003eThe free and open-source Download Manager written in pure Python\u003c/h2\u003e\n\u003ch4 align=\"center\"\u003e\n  \u003cimg alt=\"status\" src=\"https://img.shields.io/pypi/status/pyload-ng?style=flat-square\"\u003e\n  \u003ca href=\"https://github.com/pyload/pyload/actions\"\u003e\n    \u003cimg alt=\"build\" src=\"https://img.shields.io/github/actions/workflow/status/pyload/pyload/test.yml?event=push\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.codacy.com/gh/pyload/pyload\"\u003e\n    \u003cimg alt=\"codacy\" src=\"https://img.shields.io/codacy/grade/1d047f77c0a6496eb708e1b3ca83006b?label=grade\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003cimg alt=\"python\" src=\"https://img.shields.io/pypi/pyversions/pyload-ng?style=flat-square\"\u003e\n  \u003ca href=\"https://pypi.python.org/pypi/pyload-ng\"\u003e\n    \u003cimg alt=\"pypi\" src=\"https://img.shields.io/pypi/v/pyload-ng?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pyup.io/repos/github/pyload/pyload\"\u003e\n    \u003cimg alt=\"pyup\" src=\"https://pyup.io/repos/github/pyload/pyload/shield.svg\"\u003e\n  \u003c/a\u003e\n\u003c/h4\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## Choose your Version\n\n**The newest version of pyLoad** running on Python 3.6+ and PyPy (experimental) is developed in the [main branch on GitHub](https://github.com/pyload/pyload/tree/main) and published as [pyload-ng on PyPI](https://pypi.org/project/pyload-ng/).\n\n**The old version of pyLoad** working on Python 2 is still available in the [stable branch on GitHub](https://github.com/pyload/pyload/tree/stable), pre-built packages are available for download on the [releases page on GitHub](https://github.com/pyload/pyload/releases).\n\nThis README covers only the latest version of pyLoad.\n\n## Quick Start\n\nOpen a terminal window and install pyLoad typing:\n\n    pip install --pre pyload-ng[all]\n\nTo start pyLoad use the command:\n\n    pyload\n\nSee the [usage section](#usage) for information on all available options.\n\nIf you want to uninstall pyLoad:\n\n    pip uninstall pyload-ng\n\n## Usage\n\n    usage: pyload [-h] [-d] [-r] [--storagedir STORAGEDIR] [--userdir USERDIR]\n                  [--tempdir TEMPDIR] [--dry-run] [--daemon] [--version]\n\n    The free and open-source Download Manager written in pure Python\n\n    optional arguments:\n      -h, --help                    show this help message and exit\n      -d, --debug                   enable debug mode\n      -r, --reset                   reset default username/password\n      --storagedir STORAGEDIR       use this location to save downloads\n      --userdir USERDIR             use this location to store user data files\n      --tempdir TEMPDIR             use this location to store temporary files\n      --dry-run                     test start-up and exit\n      --daemon                      run as daemon\n      --version                     show program's version number and exit\n\nTo start pyLoad, type the command:\n\n    pyload\n\nThis will create the following directories (if they don't exist already):\n\n-   `~/Downloads/pyLoad`: where downloads will be saved.\n-   `~/.pyload`: where user data and configuration files are stored.\n-   `\u003cTMPDIR\u003e/pyLoad`: where temporary files are stored. `\u003cTMPDIR\u003e` is [platform-specific](https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir).\n\n\u003e **Note**:\n\u003e On Windows, user data and configuration files are stored in the directory `~\\AppData\\Roaming\\pyLoad`.\n\n### Help\n\nTo show an overview of the available options, type:\n\n    pyload --help\n\n### Web Interface\n\nOpen your web browser and visit the url http://localhost:8000 to have access to\nthe pyLoad's web interface.\n\n-   Default username: `pyload`.\n-   Default password: `pyload`.\n\n**It's highly recommended to change the default access credentials on first start**.\n\n## Advanced Installation\n\n### Stable Release\n\nGet the latest stable release of pyLoad:\n\n    pip install pyload-ng\n\n\u003e **Note**:\n\u003e No stable release yet, pyLoad is now in pre-release phase.\n\n#### Available modules\n\n-   `pyload.core`: pyLoad's heart.\n-   `pyload.plugins`: the collection of officially supported plugins for pyLoad.\n-   `pyload.webui`: a web interface to interact with pyLoad.\n\n### Development Release\n\nYou can force the installation of the latest development release of pyLoad,\nappending the option `--pre` to the installation command:\n\n    pip install --pre pyload-ng\n\n**Do not use development releases in production**. Unexpected crashes may occur.\n\n### Extra Dependencies\n\nExtra dependencies are non-essential packages that enable additional features of pyLoad.\n\nTo install them you have to append a specific tag name to the installation command.\n\n#### Available tags\n\n-   `plugins`: includes packages used by several plugins.\n-   `build`: includes packages used to [build translations](#build-translations).\n-   `all`: includes both plugins and build packages.\n\nYou can use a tag in this way:\n\n    pip install pyload-ng[plugins]\n\nOr group more together:\n\n    pip install pyload-ng[plugins][build]\n\n### Build Translations\n\nUse the command `build_locale` to retrieve and build the latest locale files (translations):\n\n    python setup.py build_locale\n\nInvoke `build_locale` before building the package (eg. `bdist_wheel`).\n\n\u003e **Note**:\n\u003e\n\u003e You don't need to build the translations if you installed pyLoad through `pip`, they're already included.\n\n## Report a Vulnerability\n\nPlease refer to [SECURITY](https://github.com/pyload/pyload/blob/main/SECURITY.md) to read our security policy.\n\n## Contribute to pyLoad\n\nPlease refer to [CONTRIBUTING](https://github.com/pyload/pyload/blob/main/CONTRIBUTING.md) to read our contribution guidelines.\n\n## Docker Images\n\n[![Docker build status](https://img.shields.io/docker/build/pyload/pyload?style=flat-square)](https://hub.docker.com/r/pyload/pyload)\n[![MicroBadger layers](https://img.shields.io/microbadger/layers/pyload/pyload?style=flat-square)](https://microbadger.com/images/pyload/pyload)\n[![MicroBadger size](https://img.shields.io/microbadger/image-size/pyload/pyload?style=flat-square)](https://microbadger.com/images/pyload/pyload)\n\n#### Available images\n\n-   `pyload/pyload:alpine`: docker image for amd64, arm and arm64v8.\n-   `pyload/pyload:ubuntu-arm32v7`: docker image for arm32v7.\n-   `pyload/pyload`: alias of `pyload/pyload:alpine`.\n\n### Create Container\n\n    docker create --name=pyload -v \u003cUSERDIR\u003e:/config -v \u003cSTORAGEDIR\u003e:/downloads --restart unless-stopped pyload/pyload\n\n\u003e **Note**:\n\u003e\n\u003e Replace `\u003cSTORAGEDIR\u003e` with the location on the host machine where you want that downloads will be saved.\n\u003e\n\u003e Replace `\u003cUSERDIR\u003e` with where you want that user data files (configurations) are stored.\n\n### Start Container\n\n    docker start pyload\n\n### Stop Container\n\n    docker stop pyload\n\n### Show Logs\n\n    docker logs -f pyload\n\n### Docker Compose\n\nCompatible with `docker-compose` v2 schemas:\n\n    ---\n    version: '2'\n    services:\n      pyload:\n        image: pyload\n        build: \u003cREPODIR\u003e\n        container_name: pyload\n        environment:\n          - PUID=1000\n          - PGID=1000\n          - TZ=Europe/London\n        volumes:\n          - \u003cUSERDIR\u003e:/config\n          - \u003cSTORAGEDIR\u003e:/downloads\n        ports:\n          - 8000:8000 # Webinterface\n          - 9666:9666 # Click 'N' Load\n        restart: unless-stopped\n\n\u003e **Note**:\n\u003e\n\u003e Replace `\u003cREPODIR\u003e` with the location on the host machine where you have checked out the pyload repository.\n\u003e\n\u003e Replace `\u003cSTORAGEDIR\u003e` with the location on the host machine where you want that downloads will be saved.\n\u003e\n\u003e Replace `\u003cUSERDIR\u003e` with where you want that user data files (configurations) are stored.\n\n## Troubleshooting\n\n### pip not found\n\nRetry replacing the command `pip` with `pip3`:\n\n    pip3 install pyload-ng\n\nIf fails again, you may not have the Python interpreter\nor the pip package manager installed on your system.\n\nTry reinstalling Python to fix this issue.\n\nVisit https://www.python.org/downloads\nto get the proper **Python 3** release for your system.\n\n### pyload-ng not found\n\nCheck the version of the Python interpreters installed on your system.\n\nTo show the version of your **default** Python interpreter, type the command:\n\n    python --version\n\nIf the version is too old, try to upgrage Python, then you can retry to install pyLoad.\n\nPython releases below version 3.6 are not supported!\n\n### Setuptools is too old\n\nTo upgrade the `setuptools` package, type the command:\n\n    pip install --upgrade setuptools\n\n### Permission denied\n\nUnder Unix-based systems, try to install pyLoad with root privileges.\n\nPrefix the installation/uninstallation command with `sudo`:\n\n    sudo pip install pyload-ng\n    sudo pip uninstall pyload-ng\n\nUnder Windows systems, open a _Command Prompt as administrator_ to install pyLoad\nwith root privileges.\n\nYou can also try to install the `pyload-ng` package **without** root privileges.\n\nAppend the option `--user` to the installation command:\n\n    pip install --user pyload-ng\n\n## Licensing\n\n[![license](https://img.shields.io/pypi/l/pyload-ng?style=flat-square)](https://github.com/pyload/pyload/blob/main/LICENSE.md)\n[![cla](https://cla-assistant.io/readme/badge/pyload/pyload)](https://cla-assistant.io/pyload/pyload)\n\n### Open Source License\n\nYou are allowed to use this software under the terms of the **GNU Affero\nGeneral Public License** as published by the Free Software Foundation;\neither **version 3** of the License, or (at your option) any later version.\n\nPlease refer to [LICENSE](https://github.com/pyload/pyload/blob/main/LICENSE.md) to read the project license.\n\n### Alternative License\n\nWith an explicit permission of the **pyLoad team** you may use or distribute\nthis software under a different license according to the agreement.\n\n### Contributor License Agreement\n\nPlease refer to [CLA](https://cla-assistant.io/pyload/pyload) for the full agreement conditions.\n\nThis is essentially what you will be agreeing to:\n\n-   You claim to have the right to make the contribution\n    (i.e. it's your own work).\n-   You grant the project a perpetual, non-exclusive license to use the\n    contribution.\n-   You grant the project rights to change the outbound license that we use to\n    distribute the code.\n-   You retain full ownership (copyright) of your submission and are free to do\n    with it as you please.\n\nContact us at licensing@pyload.net for any question about the pyLoad licensing policy.\n\n## Credits\n\nPlease refer to [AUTHORS](https://github.com/pyload/pyload/blob/main/AUTHORS.md) to know a bit more about the people behind pyLoad.\n\n\u003cbr /\u003e\n\n---\n\n###### © 2008-2025 pyLoad team\n","funding_links":["https://PayPal.Me/nitzo2001/0usd"],"categories":["Python","\u003ca id=\"tag-internet\" href=\"#tag-internet\"\u003eInternet\u003c/a\u003e","Apps","raspberry-pi","Application Recommendation","Others","Self Hosting 💾"],"sub_categories":["Download","🤖 Automation Tools","Downloaders"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyload%2Fpyload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyload%2Fpyload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyload%2Fpyload/lists"}