Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 3.85 KB

README.md

File metadata and controls

98 lines (64 loc) · 3.85 KB
Raw

Distro Dumper

Overengineered Python script and Docker container to automatically dump Linux/BSD torrents from various sources.

Usage

See the example docker-compose.yaml for example usage. The following environment variables are used to control the image and script. Defaults are for the Docker image only.

  • DUMPER_INTERVAL - Default: 3600 - Number of seconds between each check.
  • DUMPER_DIRECTORY - Default: /dump - Directory to put downloaded torrent files in. Could be a directory your Torrent client monitors for new files to auto-add.
  • DUMPER_CACHE - Default: /cache - Directory to stash cache data in, usually just the torrent files before they're copied to the dump directory.
  • DUMPER_DEBUG - If set to "true", will enable additional output.
  • DUMPER_MODULES - Comma-separated list of dumper modules to load.
  • <MODULE>_<SETTING> - Proposed settings format for specific dumper modules.

Modules

Module specific settings and considerations. Modules are mapped from name to code in the __AVAILABLE_MODULES dictionary in distrodumper/config_helper.py, so any new module should be added there.

Arch

The default behavior is to only dump the latest release. This can be changed with the following variables.

  • ARCH_GET_ALL - If set to "true", will dump all the available Arch releases on the release page.
  • ARCH_GET_AVAILABLE - If set to "true", will dump all the available Arch releases on the release page that has the available (webseed) flag set. This option is not implemented yet.

Debian

The Debian module only supports getting the "current" version, but supports many different architectures, flavors and media types. As long as they're available. :)

  • DEBIAN_ARCHS - Comma separated list of architechtures, supported architectures are: amd64, arm64, armel, armhf, i386, mips64el, mipsel, ppc64el and s390x.
  • DEBIAN_MEDIA - Comma separated list of media types, available values are cd and dvd.
  • DEBIAN_EXTRA_FLAVORS - Comma separated list of flavors, valid flavors are edu and mac. You cannot deselect the standard flavor at this time.

Note that not all combinations of architectures, media formats and flavors are actually available, and as such will net get any downloads.

Manjaro

The Manjaro module supports the official and community flavors. Arm support is not implemented yet.

  • MANJARO_FLAVORS - Comma separated list of flavors, valid flavors are kde, xfce, gnome, budgie, cinnamon, i3 and mate. Note that Sway and Docker is not supported as they are external links.

Raspberry Pi OS

The Raspbery Pi OS module supports the arm and x86 releases. The oldstable releases are not supported.

  • RPIOS_IMAGES - Comma separated list of flavors, valid flavors are raspios_armhf, raspios_full_armhf, raspios_lite_armhf, raspios_arm64, raspios_lite_arm64 and rpd_x86.

Development

I've only tested with Python 3.9, but some earlier and all later versions should work as well.

  • Create a virtual environment: $ python3 -m virtualenv venv.
  • Activate the environment: $ source venv/bin/activate.
  • Install dependencies: $ pip install -r requirements-dev.txt.
  • Go ham. :)

Testing & Linting

Testing and linting is done through tox environments, make sure you have tox installed and run any of the environments:

  • tox -e py39 - Runs the package tests with Python 3.9.
  • tox -e py310 - Runs the package tests with Python 3.10.
  • tox -e py311 - Runs the package tests with Python 3.11.
  • tox -e lint - Runs pylint and outputs the result.
  • tox -e cov - Runs the package tests with the code coverage analysis.

Dependency pinning

Dependencies are pinned with pip-tools. So any changes should be done via the .in files, and calling pip-compile.