Repository files navigation

The newest version of pyLoad running on Python 3.9+ is developed in themain branch on GitHub and published aspyload-ng on PyPI.

The old version of pyLoad working on Python 2 is still available in thestable branch on GitHub, pre-built packages are available for download on thereleases page on GitHub.

This README covers only the latest version of pyLoad.

Open a terminal window and install pyLoad typing:

pip install --pre pyload-ng[all]

To start pyLoad use the command:

pyload

See theusage section for information on all available options.

If you want to uninstall pyLoad:

pip uninstall pyload-ng

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 Pythonoptional 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> isplatform-specific.

Note:On Windows, user data and configuration files are stored in the directory~\AppData\Roaming\pyLoad.

To show an overview of the available options, type:

pyload --help

Open your web browser and visit the urlhttp://localhost:8000 to have access tothe pyLoad's web interface.

• Default username:pyload.
• Default password:pyload.

It's highly recommended to change the default access credentials on first start.

Get the latest stable release of pyLoad:

pip install pyload-ng

Note:No stable release yet, pyLoad is now in pre-release phase.

• pyload.core: pyLoad's heart.
• pyload.plugins: the collection of officially supported plugins for pyLoad.
• pyload.webui: a web interface to interact with pyLoad.

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 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.

• plugins: includes packages used by several plugins.
• build: includes packages used tobuild 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]

Use the commandbuild_locale to retrieve and build the latest locale files (translations):

python setup.py build_locale

Invokebuild_locale before building the package (eg.bdist_wheel).

Note:

You don't need to build the translations if you installed pyLoad throughpip, they're already included.

pyLoad provides an OpenAPI specification for its REST API, visible via Swagger UI under the endpoint

<pyload base url>/api/docs

The specification file itself is available under

<pyload base url>/api/openapi.json

Based on this file. it is possible to generate client code with theofficial OpenAPI code generator.

For example, this command will generate a client for Android, using the dockerized generator:

docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate \  -i /local/openapi-generator/openapi.json \  -g java \  -o /local/openapi-generator/out \  --additional-properties library=retrofit2,serializationLibrary=gson,openApiNullable=false,hideGenerationTimestamp=true,invokerPackage=org.pyload.android.openapi,apiPackage=org.pyload.android.openapi.api,modelPackage=org.pyload.android.openapi.models

If you are developing a client application for pyLoad, you can use this specification to generate a clientin any language / framework the OpenAPI generator supports.

The API specification is parsed from the REST API implementation and should not be edited manually.Instead, if changes have been made to the API, re-generate the specification by running

pyload --generate-api-spec

which will produce an updatedopenapi.json file.

Please refer toSECURITY to read our security policy.

Please refer toCONTRIBUTING to read our contribution guidelines.

• pyload/pyload:alpine: docker image for amd64, arm and arm64v8.
• pyload/pyload:ubuntu-arm32v7: docker image for arm32v7.
• pyload/pyload: alias ofpyload/pyload:alpine.

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.

docker start pyload

docker stop pyload

docker logs -f pyload

Compatible withdocker-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.

Retry replacing the commandpip withpip3:

pip3 install pyload-ng

If fails again, you may not have the Python interpreteror the pip package manager installed on your system.

Try reinstalling Python to fix this issue.

Visithttps://www.python.org/downloadsto get the properPython 3 release for your system.

Check the version of the Python interpreters installed on your system.

To show the version of yourdefault 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.9 are not supported!

To upgrade thesetuptools package, type the command:

pip install --upgrade setuptools

Under Unix-based systems, try to install pyLoad with root privileges.

Prefix the installation/uninstallation command withsudo:

sudo pip install pyload-ngsudo pip uninstall pyload-ng

Under Windows systems, open aCommand Prompt as administrator to install pyLoadwith root privileges.

You can also try to install thepyload-ng packagewithout root privileges.

Append the option--user to the installation command:

pip install --user pyload-ng

You are allowed to use this software under the terms of theGNU AfferoGeneral Public License as published by the Free Software Foundation;eitherversion 3 of the License, or (at your option) any later version.

Please refer toLICENSE to read the project license.

With an explicit permission of thepyLoad team you may use or distributethis software under a different license according to the agreement.

Please refer toCLA 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 thecontribution.
• You grant the project rights to change the outbound license that we use todistribute the code.
• You retain full ownership (copyright) of your submission and are free to dowith it as you please.

Contact us atlicensing@pyload.net for any question about the pyLoad licensing policy.

Please refer toAUTHORS to know a bit more about the people behind pyLoad.