<br />
<p align="center">
<img src="https://raw.githubusercontent.com/pyload/pyload/main/media/banner.png" alt="pyLoad" height="110" />
</p>
<h2 align="center">The free and open-source Download Manager written in pure Python</h2>
<h4 align="center">
<img alt="status" src="https://img.shields.io/pypi/status/pyload-ng?style=flat-square">
<a href="https://github.com/pyload/pyload/actions">
<img alt="build" src="https://img.shields.io/github/actions/workflow/status/pyload/pyload/test.yml?event=push&style=flat-square">
</a>
<a href="https://www.codacy.com/gh/pyload/pyload">
<img alt="codacy" src="https://img.shields.io/codacy/grade/1d047f77c0a6496eb708e1b3ca83006b?label=grade&style=flat-square">
</a>
<img alt="python" src="https://img.shields.io/pypi/pyversions/pyload-ng?style=flat-square">
<a href="https://pypi.python.org/pypi/pyload-ng">
<img alt="pypi" src="https://img.shields.io/pypi/v/pyload-ng?style=flat-square">
</a>
<a href="https://pyup.io/repos/github/pyload/pyload">
<img alt="pyup" src="https://pyup.io/repos/github/pyload/pyload/shield.svg">
</a>
</h4>
<br />
<br />
## Choose your Version
**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/).
**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).
This README covers only the latest version of pyLoad.
## Quick Start
Open a terminal window and install pyLoad typing:
pip install --pre pyload-ng[all]
To start pyLoad use the command:
pyload
See the [usage section](#usage) for information on all available options.
If you want to uninstall pyLoad:
pip uninstall pyload-ng
## Usage
usage: pyload [-h] [-d] [-r] [--storagedir STORAGEDIR] [--userdir USERDIR]
[--tempdir TEMPDIR] [--dry-run] [--daemon] [--version]
The free and open-source Download Manager written in pure Python
optional arguments:
-h, --help show this help message and exit
-d, --debug enable debug mode
-r, --reset reset default username/password
--storagedir STORAGEDIR use this location to save downloads
--userdir USERDIR use this location to store user data files
--tempdir TEMPDIR use this location to store temporary files
--dry-run test start-up and exit
--daemon run as daemon
--version show program's version number and exit
To start pyLoad, type the command:
pyload
This will create the following directories (if they don't exist already):
- `~/Downloads/pyLoad`: where downloads will be saved.
- `~/.pyload`: where user data and configuration files are stored.
- `<TMPDIR>/pyLoad`: where temporary files are stored. `<TMPDIR>` is [platform-specific](https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir).
> **Note**:
> On Windows, user data and configuration files are stored in the directory `~\AppData\Roaming\pyLoad`.
### Help
To show an overview of the available options, type:
pyload --help
### Web Interface
Open your web browser and visit the url http://localhost:8000 to have access to
the pyLoad's web interface.
- Default username: `pyload`.
- Default password: `pyload`.
**It's highly recommended to change the default access credentials on first start**.
## Advanced Installation
### Stable Release
Get the latest stable release of pyLoad:
pip install pyload-ng
> **Note**:
> No stable release yet, pyLoad is now in pre-release phase.
#### Available modules
- `pyload.core`: pyLoad's heart.
- `pyload.plugins`: the collection of officially supported plugins for pyLoad.
- `pyload.webui`: a web interface to interact with pyLoad.
### Development Release
You can force the installation of the latest development release of pyLoad,
appending the option `--pre` to the installation command:
pip install --pre pyload-ng
**Do not use development releases in production**. Unexpected crashes may occur.
### Extra Dependencies
Extra dependencies are non-essential packages that enable additional features of pyLoad.
To install them you have to append a specific tag name to the installation command.
#### Available tags
- `plugins`: includes packages used by several plugins.
- `build`: includes packages used to [build translations](#build-translations).
- `all`: includes both plugins and build packages.
You can use a tag in this way:
pip install pyload-ng[plugins]
Or group more together:
pip install pyload-ng[plugins][build]
### Build Translations
Use the command `build_locale` to retrieve and build the latest locale files (translations):
python setup.py build_locale
Invoke `build_locale` before building the package (eg. `bdist_wheel`).
> **Note**:
>
> You don't need to build the translations if you installed pyLoad through `pip`, they're already included.
## Report a Vulnerability
Please refer to [SECURITY](https://github.com/pyload/pyload/blob/main/SECURITY.md) to read our security policy.
## Contribute to pyLoad
Please refer to [CONTRIBUTING](https://github.com/pyload/pyload/blob/main/CONTRIBUTING.md) to read our contribution guidelines.
## Docker Images
[](https://hub.docker.com/r/pyload/pyload)
[](https://microbadger.com/images/pyload/pyload)
[](https://microbadger.com/images/pyload/pyload)
#### Available images
- `pyload/pyload:alpine`: docker image for amd64, arm and arm64v8.
- `pyload/pyload:ubuntu-arm32v7`: docker image for arm32v7.
- `pyload/pyload`: alias of `pyload/pyload:alpine`.
### Create Container
docker create --name=pyload -v <USERDIR>:/config -v <STORAGEDIR>:/downloads --restart unless-stopped pyload/pyload
> **Note**:
>
> Replace `<STORAGEDIR>` with the location on the host machine where you want that downloads will be saved.
>
> Replace `<USERDIR>` with where you want that user data files (configurations) are stored.
### Start Container
docker start pyload
### Stop Container
docker stop pyload
### Show Logs
docker logs -f pyload
### Docker Compose
Compatible with `docker-compose` v2 schemas:
---
version: '2'
services:
pyload:
image: pyload
build: <REPODIR>
container_name: pyload
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- <USERDIR>:/config
- <STORAGEDIR>:/downloads
ports:
- 8000:8000 # Webinterface
- 9666:9666 # Click 'N' Load
restart: unless-stopped
> **Note**:
>
> Replace `<REPODIR>` with the location on the host machine where you have checked out the pyload repository.
>
> Replace `<STORAGEDIR>` with the location on the host machine where you want that downloads will be saved.
>
> Replace `<USERDIR>` with where you want that user data files (configurations) are stored.
## Troubleshooting
### pip not found
Retry replacing the command `pip` with `pip3`:
pip3 install pyload-ng
If fails again, you may not have the Python interpreter
or the pip package manager installed on your system.
Try reinstalling Python to fix this issue.
Visit https://www.python.org/downloads
to get the proper **Python 3** release for your system.
### pyload-ng not found
Check the version of the Python interpreters installed on your system.
To show the version of your **default** Python interpreter, type the command:
python --version
If the version is too old, try to upgrage Python, then you can retry to install pyLoad.
Python releases below version 3.6 are not supported!
### Setuptools is too old
To upgrade the `setuptools` package, type the command:
pip install --upgrade setuptools
### Permission denied
Under Unix-based systems, try to install pyLoad with root privileges.
Prefix the installation/uninstallation command with `sudo`:
sudo pip install pyload-ng
sudo pip uninstall pyload-ng
Under Windows systems, open a _Command Prompt as administrator_ to install pyLoad
with root privileges.
You can also try to install the `pyload-ng` package **without** root privileges.
Append the option `--user` to the installation command:
pip install --user pyload-ng
## Licensing
[](https://github.com/pyload/pyload/blob/main/LICENSE.md)
[](https://cla-assistant.io/pyload/pyload)
### Open Source License
You are allowed to use this software under the terms of the **GNU Affero
General Public License** as published by the Free Software Foundation;
either **version 3** of the License, or (at your option) any later version.
Please refer to [LICENSE](https://github.com/pyload/pyload/blob/main/LICENSE.md) to read the project license.
### Alternative License
With an explicit permission of the **pyLoad team** you may use or distribute
this software under a different license according to the agreement.
### Contributor License Agreement
Please refer to [CLA](https://cla-assistant.io/pyload/pyload) for the full agreement conditions.
This is essentially what you will be agreeing to:
- You claim to have the right to make the contribution
(i.e. it's your own work).
- You grant the project a perpetual, non-exclusive license to use the
contribution.
- You grant the project rights to change the outbound license that we use to
distribute the code.
- You retain full ownership (copyright) of your submission and are free to do
with it as you please.
Contact us at licensing@pyload.net for any question about the pyLoad licensing policy.
## Credits
Please refer to [AUTHORS](https://github.com/pyload/pyload/blob/main/AUTHORS.md) to know a bit more about the people behind pyLoad.
<br />
---
###### © 2008-2024 pyLoad team
Raw data
{
"_id": null,
"home_page": "https://pyload.net",
"name": "pyload-ng",
"maintainer": "Walter Purcaro",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "vuolter@gmail.com",
"keywords": "pyload, download-manager, one-click-hoster, download",
"author": "pyLoad team",
"author_email": "support@pyload.net",
"download_url": "https://files.pythonhosted.org/packages/b3/3f/0cc92eabb8f6939c66dce213e3f33f55b2e010e09b60285893d2c96f6584/pyload_ng-0.5.0b3.dev82.tar.gz",
"platform": "any",
"description": "<br />\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/pyload/pyload/main/media/banner.png\" alt=\"pyLoad\" height=\"110\" />\n</p>\n<h2 align=\"center\">The free and open-source Download Manager written in pure Python</h2>\n<h4 align=\"center\">\n <img alt=\"status\" src=\"https://img.shields.io/pypi/status/pyload-ng?style=flat-square\">\n <a href=\"https://github.com/pyload/pyload/actions\">\n <img alt=\"build\" src=\"https://img.shields.io/github/actions/workflow/status/pyload/pyload/test.yml?event=push&style=flat-square\">\n </a>\n <a href=\"https://www.codacy.com/gh/pyload/pyload\">\n <img alt=\"codacy\" src=\"https://img.shields.io/codacy/grade/1d047f77c0a6496eb708e1b3ca83006b?label=grade&style=flat-square\">\n </a>\n <img alt=\"python\" src=\"https://img.shields.io/pypi/pyversions/pyload-ng?style=flat-square\">\n <a href=\"https://pypi.python.org/pypi/pyload-ng\">\n <img alt=\"pypi\" src=\"https://img.shields.io/pypi/v/pyload-ng?style=flat-square\">\n </a>\n <a href=\"https://pyup.io/repos/github/pyload/pyload\">\n <img alt=\"pyup\" src=\"https://pyup.io/repos/github/pyload/pyload/shield.svg\">\n </a>\n</h4>\n\n<br />\n<br />\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- `<TMPDIR>/pyLoad`: where temporary files are stored. `<TMPDIR>` is [platform-specific](https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir).\n\n> **Note**:\n> 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> **Note**:\n> 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> **Note**:\n>\n> 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[](https://hub.docker.com/r/pyload/pyload)\n[](https://microbadger.com/images/pyload/pyload)\n[](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 <USERDIR>:/config -v <STORAGEDIR>:/downloads --restart unless-stopped pyload/pyload\n\n> **Note**:\n>\n> Replace `<STORAGEDIR>` with the location on the host machine where you want that downloads will be saved.\n>\n> Replace `<USERDIR>` 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: <REPODIR>\n container_name: pyload\n environment:\n - PUID=1000\n - PGID=1000\n - TZ=Europe/London\n volumes:\n - <USERDIR>:/config\n - <STORAGEDIR>:/downloads\n ports:\n - 8000:8000 # Webinterface\n - 9666:9666 # Click 'N' Load\n restart: unless-stopped\n\n> **Note**:\n>\n> Replace `<REPODIR>` with the location on the host machine where you have checked out the pyload repository.\n>\n> Replace `<STORAGEDIR>` with the location on the host machine where you want that downloads will be saved.\n>\n> Replace `<USERDIR>` 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[](https://github.com/pyload/pyload/blob/main/LICENSE.md)\n[](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<br />\n\n---\n\n###### \u00a9 2008-2024 pyLoad team\n",
"bugtrack_url": null,
"license": "agpl3",
"summary": "The free and open-source Download Manager written in pure Python",
"version": "0.5.0b3.dev82",
"project_urls": {
"Bug Tracker": "https://github.com/pyload/pyload/issues",
"Documentation": "https://github.com/pyload/pyload/wiki",
"Download": "https://github.com/pyload/pyload/releases",
"Homepage": "https://pyload.net",
"Source Code": "https://github.com/pyload/pyload",
"Source Code (mirror)": "https://gitlab.com/pyload/pyload"
},
"split_keywords": [
"pyload",
" download-manager",
" one-click-hoster",
" download"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89977c363bd844617b14beccee518f6f60f99dfe235e9cd176ca6b33c98bab11",
"md5": "2628958f6a84fdc4ad727c0562141a84",
"sha256": "dab99b29f8253a7d42e12fcede1bd8d24c17601c82754ed743caecb208030c4a"
},
"downloads": -1,
"filename": "pyload_ng-0.5.0b3.dev82-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2628958f6a84fdc4ad727c0562141a84",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1633399,
"upload_time": "2024-04-21T02:38:29",
"upload_time_iso_8601": "2024-04-21T02:38:29.408532Z",
"url": "https://files.pythonhosted.org/packages/89/97/7c363bd844617b14beccee518f6f60f99dfe235e9cd176ca6b33c98bab11/pyload_ng-0.5.0b3.dev82-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b33f0cc92eabb8f6939c66dce213e3f33f55b2e010e09b60285893d2c96f6584",
"md5": "78d7469e66fdd45b0001f26d56eba1ea",
"sha256": "839a2a5d5f009f3c015e20b10316e85ec48fbe305324f543dc4d26c1d1062c70"
},
"downloads": -1,
"filename": "pyload_ng-0.5.0b3.dev82.tar.gz",
"has_sig": false,
"md5_digest": "78d7469e66fdd45b0001f26d56eba1ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 1256692,
"upload_time": "2024-04-21T02:38:32",
"upload_time_iso_8601": "2024-04-21T02:38:32.435526Z",
"url": "https://files.pythonhosted.org/packages/b3/3f/0cc92eabb8f6939c66dce213e3f33f55b2e010e09b60285893d2c96f6584/pyload_ng-0.5.0b3.dev82.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-21 02:38:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyload",
"github_project": "pyload",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pyload-ng"
}
JSON
