Skip to main content

setuptools plugin to download external files

Project description

build status pre-commit.ci status

setuptools-download

setuptools plugin to download external files

usage

this plugin is intended to be used through setuptools declarative metadata:

the value of download_* is an ini-like string with the section being the filename.

file settings

  • url (required): url to download the file from
  • sha256 (required): checksum of the downloaded file
  • group + marker (optional or required together)
    • group: a name for a mutually exclusive group
    • marker: a PEP 508 marker expression (can be specified multiple times)
      • only supports: os_name, sys_platform, platform_machine
  • extract + extract_path (optional or required together)
    • extract: how to extract the downloaded file (zip or tar)
    • extract_path: path to extract from archive

example

[options]
setup_requires = setuptools-download

[setuptools_download]
download_data_files =
    [share/example/data.txt]
    url = https://example.com/data.txt
    sha256 = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
    [share/example/embedded]
    url = https://example.com/release-1.0.tar.gz
    sha256 = bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
    extract = tar
    extract_path = release-v1.0/share/example/embedded
download_scripts =
    [example-tool]
    group = example-tool-binary
    marker = sys_platform == "linux" and platform_machine == "x86_64"
    url = https://example.com/example-tool-linux-x86-64
    sha256 = ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
    [example-tool]
    group = example-tool-binary
    marker = sys_platform == "darwin" and platform_machine == "x86_64"
    marker = sys_platform == "darwin" and platform_machine == "arm64"
    url = https://example.com/example-tool-darwin-x86-64
    sha256 = ddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd
    [example-tool.exe]
    group = example-tool-binary
    marker = sys_platform == "win32" and platform_machine == "AMD64"
    url = https://example.com/example-tool-win32.exe
    sha256 = eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

setuptools_download-1.1.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

setuptools_download-1.1.0-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file setuptools_download-1.1.0.tar.gz.

File metadata

  • Download URL: setuptools_download-1.1.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.12

File hashes

Hashes for setuptools_download-1.1.0.tar.gz
Algorithm Hash digest
SHA256 f91f1b6b73104b064519759688d2ccfb37e955a5e475d64526474f248f66a7b6
MD5 6357587b50e120333b69b591f6b51156
BLAKE2b-256 7f63a8dd51f599b21cbd34e09485e6086e9b1aa9d0b0f6b749b7e4efab8f3727

See more details on using hashes here.

File details

Details for the file setuptools_download-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for setuptools_download-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f11d92f40622df97390e249316366f868cbcdd1100a7569d0f22973e405028f7
MD5 1bbcb3be544d2ea833e4bd0f8beca413
BLAKE2b-256 0d1ab49efff1c04e5aa0dd09415d0f0c0a2d75c7735e78b0fa18a7864d3d260c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page