pyload-ng 0.5.0b3.dev96__tar.gz → 0.5.0b3.dev97__tar.gz

pyload_ng-0.5.0b3.dev97/PKG-INFO

@@ -0,0 +1,463 @@
+Metadata-Version: 2.4
+Name: pyload-ng
+Version: 0.5.0b3.dev97
+Summary: The free and open-source Download Manager written in pure Python
+Home-page: https://pyload.net
+Download-URL: https://github.com/pyload/pyload/releases
+Author: pyLoad team
+Author-email: support@pyload.net
+Maintainer: Walter Purcaro
+Maintainer-email: vuolter@gmail.com
+License: agpl3
+Project-URL: Source Code (mirror), https://gitlab.com/pyload/pyload
+Project-URL: Source Code, https://github.com/pyload/pyload
+Project-URL: Bug Tracker, https://github.com/pyload/pyload/issues
+Project-URL: Documentation, https://github.com/pyload/pyload/wiki
+Keywords: pyload,download-manager,one-click-hoster,download
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Plugins
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Communications
+Classifier: Topic :: Communications :: File Sharing
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: File Transfer Protocol (FTP)
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: aia-chaser>=0.9.0
+Requires-Dist: Cheroot
+Requires-Dist: Flask
+Requires-Dist: Flask-Babel
+Requires-Dist: Flask-Caching~=1.9
+Requires-Dist: Flask-Compress~=1.8
+Requires-Dist: Flask-Session
+Requires-Dist: Flask-Themes2~=1.0
+Requires-Dist: Flask-WTF
+Requires-Dist: bitmath~=1.3
+Requires-Dist: cryptography>=35.0.0
+Requires-Dist: defusedxml
+Requires-Dist: filetype~=1.0
+Requires-Dist: mini-racer
+Requires-Dist: packaging
+Requires-Dist: pycurl
+Requires-Dist: pydantic
+Requires-Dist: certifi
+Requires-Dist: semver~=2.10
+Requires-Dist: setuptools>=38.3
+Provides-Extra: all
+Requires-Dist: beautifulsoup4; extra == "all"
+Requires-Dist: colorlog; extra == "all"
+Requires-Dist: Pillow; extra == "all"
+Requires-Dist: pyOpenSSL; extra == "all"
+Requires-Dist: slixmpp; extra == "all"
+Requires-Dist: Send2Trash; extra == "all"
+Requires-Dist: Babel; extra == "all"
+Requires-Dist: Jinja2; extra == "all"
+Provides-Extra: build
+Requires-Dist: Babel; extra == "build"
+Requires-Dist: Jinja2; extra == "build"
+Provides-Extra: plugins
+Requires-Dist: beautifulsoup4; extra == "plugins"
+Requires-Dist: colorlog; extra == "plugins"
+Requires-Dist: Pillow; extra == "plugins"
+Requires-Dist: pyOpenSSL; extra == "plugins"
+Requires-Dist: slixmpp; extra == "plugins"
+Requires-Dist: Send2Trash; extra == "plugins"
+Dynamic: download-url
+Dynamic: license-file
+
+<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/build-and-deploy.yml">
+  </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 />
+
+## Overview
+
+pyLoad is a lightweight, pure-Python download manager with a modern web UI and rich plugin ecosystem. It automates downloads from one-click hosters, cloud drives, and many other sources; supports premium accounts, captcha-solving services, and link decryption; and can run headless on servers, NAS devices, or desktops. Designed for extensibility and low resource usage.
+
+## Introduction
+
+- Cross-platform: works on Linux, macOS, and Windows (Python 3.9+)
+- Web interface: manage downloads from your browser
+- Plugin-driven: hundreds of hosters, decrypters, and addons (notifications, schedulers, extractors, etc.)
+
+## 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.
+
+## Development
+
+### Set up your development environment
+
+* Clone the repository
+* Recommended: create a virtual environment for pyLoad
+```
+python3 -m venv .venv
+source .venv/bin/activate
+```
+* Install pyLoad as editable install
+```
+pip install -e .
+```
+* Run pyLoad in debug mode
+```
+pyload -d
+```
+
+### API specification
+
+pyLoad provides an OpenAPI specification for its REST API, visible via Swagger UI under the endpoint
+
+    <pyload base url>/api/
+
+The specification file itself is available under
+
+    <pyload base url>/api/openapi.json
+
+For reference, there is a local copy of the API specification in `openapi-generator/openapi.json`.
+Based on this file, it is possible to generate client code with the [official OpenAPI code generator](https://github.com/OpenAPITools/openapi-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 client
+in any language / framework the OpenAPI generator supports.
+
+The API specification is parsed from the REST API implementation.
+The local `openapi.json` copy should not be edited manually.
+Instead, if changes have been made to the API, re-generate the specification file by running
+
+    pyload --generate-api-spec 
+
+which will update the `openapi.json` file in place.
+
+## 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
+
+[![Docker build status](https://img.shields.io/docker/build/pyload/pyload?style=flat-square)](https://hub.docker.com/r/pyload/pyload)
+
+#### Available images
+
+-   [linuxserver/pyload-ng](https://hub.docker.com/r/linuxserver/pyload-ng)
+
+[//]: # (-   `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.9 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
+
+[![license](https://img.shields.io/pypi/l/pyload-ng?style=flat-square)](https://github.com/pyload/pyload/blob/main/LICENSE.md)
+[![cla](https://cla-assistant.io/readme/badge/pyload/pyload)](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-2026 pyLoad team

pyload_ng-0.5.0b3.dev97/setup.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+#       ____________
+#   ___/       |    \_____________ _                 _ ___
+#  /        ___/    |    _ __ _  _| |   ___  __ _ __| |   \
+# /    \___/  ______/   | '_ \ || | |__/ _ \/ _` / _` |    \
+# \            ◯ |      | .__/\_, |____\___/\__,_\__,_|    /
+#  \_______\    /_______|_|   |__/________________________/
+#           \  /
+#            \/
+
+import importlib.metadata
+import os
+
+import packaging.version
+# from pkg_resources import VersionConflict, require
+from setuptools import Command, setup
+
+# import sys
+
+
+# try:
+#     require("setuptools>=38.3")
+# except VersionConflict:
+#     print("Error: version of setuptools is too old (<38.3)!")
+#     sys.exit(1)
+
+
+class BuildLocale(Command):
+    """
+    Build translations
+    """
+
+    description = "build locales"
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        jinja2_version = importlib.metadata.version("jinja2")
+        if packaging.version.Version(jinja2_version) < packaging.version.Version(
+            "3.0.0"
+        ):
+            mapping_file_version = 2
+        else:
+            mapping_file_version = 3
+        mapping_file = f"babel_v{mapping_file_version}.cfg"
+
+        with open(mapping_file, "r", encoding="utf-8-sig") as fp:
+            mapping = fp.read()
+        input_dirs = self.distribution.get_option_dict("extract_messages")[
+            "input_dirs"
+        ][1]
+
+        self.distribution.message_extractors = {input_dirs: mapping}
+
+    def _execute(self, func_name, cmd_list):
+        execute = getattr(self, func_name)
+        for cmd_name in cmd_list:
+            execute(cmd_name)
+
+    def run(self):
+        # TODO: add "download_catalog"
+        commands = ["extract_messages", "init_catalog", "compile_catalog"]
+
+        if self.dry_run:
+            self._execute("get_command_name", commands)
+        else:
+            dirname = os.path.join(os.path.dirname(__file__), "src", "pyload", "locale")
+            self.mkpath(
+                dirname
+            )  # NOTE: do we have to pass dry_run value explicitly here?
+            self._execute("run_command", commands)
+
+
+def retrieve_version():
+    version = None
+    build = (
+        int(os.environ["PYLOAD_BUILD"].strip()) if "PYLOAD_BUILD" in os.environ else 0
+    )
+
+    filename = os.path.join(os.path.dirname(__file__), "VERSION")
+    with open(filename) as fp:
+        version = os.environ.get("PYLOAD_VERSION", fp.read()).strip()
+
+    return f"{version}.dev{build}" if build else version
+
+
+# TODO: BuildDocs running `sphinx-apidoc`
+if __name__ == "__main__":
+    setup(
+        version=retrieve_version(),
+        cmdclass={"build_locale": BuildLocale},
+    )

pyload_ng-0.5.0b3.dev97/src/pyload/__init__.py

@@ -0,0 +1,71 @@
+#       ____________
+#   ___/       |    \_____________ _                 _ ___
+#  /        ___/    |    _ __ _  _| |   ___  __ _ __| |   \
+# /    \___/  ______/   | '_ \ || | |__/ _ \/ _` / _` |    \
+# \            ◯ |      | .__/\_, |____\___/\__,_\__,_|    /
+#  \_______\    /_______|_|   |__/________________________/
+#           \  /
+#            \/
+
+import importlib.metadata
+import importlib.resources
+import packaging.version
+import locale
+import logging
+import os
+import sys
+import traceback
+
+import _locale
+import semver
+
+# Info
+APPID = "pyload"
+PKGNAME = "pyload-ng"
+PKGDIR = str(importlib.resources.files(__name__))
+
+USERHOMEDIR = os.path.expanduser("~")
+os.chdir(USERHOMEDIR)
+
+try:
+    __version__ = packaging.version.Version(importlib.metadata.version(PKGNAME)).base_version
+except importlib.metadata.PackageNotFoundError:
+    __version__ =  "0.5.0"
+__version_info__ = semver.parse_version_info(__version__)
+
+# Application wide global storage
+class __storage:
+    def get(self, name, default=None):
+        return self.__dict__.get(name, default)
+    def items(self):
+        return self.__dict__.items()
+    def keys(self):
+        return self.__dict__.keys()
+    def values(self):
+        return self.__dict__.values()
+    def clear(self):
+        self.__dict__.clear()
+    def __contains__(self, name):
+        return name in self.__dict__
+g = __storage()
+
+# Locale
+locale.setlocale(locale.LC_ALL, "")
+if os.name == "nt":
+    _locale._getdefaultlocale = lambda *args: ["en_US", "utf_8_sig"]
+
+
+# Exception logger
+exc_logger = logging.getLogger("exception")
+
+
+def excepthook(exc_type, exc_value, exc_traceback):
+    if issubclass(exc_type, KeyboardInterrupt):
+        sys.__excepthook__(exc_type, exc_value, exc_traceback)
+        return
+    msg_list = traceback.format_exception_only(exc_type, exc_value)
+    exc_info = (exc_type, exc_value, exc_traceback)
+    exc_logger.exception(msg_list[-1], exc_info=exc_info)
+
+
+sys.excepthook = excepthook