Skip to main content

Brandon the Devpi Builder

Coverage Status Latest Version

Brandon, the devpi builder, takes a requirements.txt and incrementally fills a devpi index with wheels of the listed python packages.

Brandon by Example

Given a requirements.txt, we can upload all listed packages to the index opensource/Debian_7 on a local devpi using the following command:

$ devpi-builder requirements.txt http://localhost:3141/opensource/Debian_7

Example of such a requirements.txt:

progressbar==0.2.2
progressbar==0.2.1
PyYAML==3.11

Commandline Usage

usage: devpi-builder [-h] [--batch] [--user USER] [--password PASSWORD]
                    [--blacklist BLACKLIST] [--pure-index PURE_INDEX]
                    [--junit-xml JUNIT_XML] [--run-id RUN_ID] [--dry-run]
                    [--client-cert CLIENT_CERT]
                    requirements index

Create wheels for all given project versions and upload them to the given
index.

positional arguments:
requirements          requirements.txt style file specifying which project
                        versions to package.
index                 The index to upload the packaged software to.

optional arguments:
-h, --help            show this help message and exit
--batch               Batch mode. Do not prompt for credentials
--user USER           The user to log in as.
--password PASSWORD   Password of the user.
--blacklist BLACKLIST
                        Packages matched by this requirements.txt style file
                        will never be build.
--pure-index PURE_INDEX
                        The index to use for pure packages. Any non-pure
                        package will be uploaded to the index given as
                        positional argument. Packages already found in the
                        pure index will not be built, either.
--junit-xml JUNIT_XML
                        Write information about the build success / failure to
                        a JUnit-compatible XML file.
--run-id RUN_ID       Add the given string to all entries in the XML output,
                        allowing to distinguish output from multiple runs in a
                        merged XML.
--dry-run             Build missing wheels, but do not modify the state of
                        the devpi server.
--client-cert CLIENT_CERT
                        Client key to use to authenticate with the devpi
                        server.

The following environment variables can be used instead of command line arguments:

DEVPI_USER

The value of this environment variable will be used if --user is not given.

DEVPI_PASSWORD

The value of this environment variable will be used if --password is not given.

Features

  • Read a requirements.txt style input file.

  • Read user/pass from the environment (using DEVPI_USER and DEVPI_PASSWORD).

  • Support multiple versions of a package in the same file.

  • Only build packages not yet in the target index.

  • Support a black-list for packages to never be built and uploaded (certain packages like numpy are fragile regarding their interdependency with other packages).

  • Can use separate indices for plain python packages and those with binary contents.

  • Can log build results to a JUnit compatible XML file, thus that it can be parsed by Jenkins.

License

New BSD

Changelog

This lists the most important changes for each release.

Version 7.1.0 - 2026-10-22

Added

  • Verified compatibility with Python 3.15.

  • Compatibility with newer version of setuptools and wheel-filename.

Removed

  • Compatibility with Python 3.10 is no longer verified.

  • Removed deprecated universal wheel configuration from test fixtures.

Changed

  • Refreshed the locked test dependencies for Python 3.11+.

  • Requires wheel-filename 2.0 or newer.

  • JUnit XML reports are written with built-in open instead of deprecated codecs.open.

Removed

  • Removed the remaining use of pkg_resources.

Version 7.0.0 - 2026-02-16

Added

  • Support for Python 3.12 and 3.13.

  • Compatibility with junit-xml >= 2.0.

Fixed

  • Ensure Setuptools and wheel-filename are installed in compatible versions.

Removed

  • Python 3.6 to 3.8 are no longer supported. They likely still works but we will no longer run CI against it.

  • Compatibility with junit-xml < 1.9. Junit-xml 1.9 was released more than three years ago.

Version 6.1.0 — 2023-09-22

Added

  • Support using VCS URLs in requirements files.

Fixed

  • Building wheels for packages like zope-event that normalise the project name using dots instead of underscores is no longer broken.

Version 6.0.0 — 2023-06-09

Added

  • Python 3.10 and 3.11 are now supported.

Changed

  • Improved performance of checking for already built packages.

Removed

  • Dropped support for running tests via setup.py test. The mechanism is considered deprecated by upstream and removing it allows us to drop a dependency.

  • Python 3.6 is no longer supported. It likely still works but we will no longer run CI against it.

Version 5.1.0 — 2021-11-05

Added

  • Provide compatibility with pip 21.3 and above which drops the –build-directory option. Pip has been using a temporary directory for builds since version 1.2 so manual handling of this directory should not be necessary anymore.

Version 5.0.1 – 2020-09-09

Fixed

  • Adhere to case-insensivity when comparing package names. This will lead to blacklisting ‘cython’ vs. ‘Cython’ being the same thing.

Version 5.0.0 – 2020-04-24

Fixed

  • Remove dependency on the internal wheel API. This blocked the use of wheel versions >= 0.32.

Removed

  • Python 2 is no longer supported.

  • Python 3.5 is no longer supported.

Version 4.0.0 – 2018-11-02

Fixed

  • Correctly specify the dependency to Wheel to avoid the latest, incompatible versions.

Removed

  • Python 3.3 and Python 3.4 are no longer supported.

Version 3.0.1 — 2017-11-21

Fixed

  • Properly handle non-ASCII characters in the output of failed package builds. Previous versions used to crash in this case if a JUnit XML output file was requested.

Version 3.0.0 — 2017-06-16

Added

  • The command line parameter --batch can be used to disable any prompts.

Changed

  • The way credentials are passed has been changed in an incompatible way. The positional arguments for user and password no longer exist. Instead, use one of the following:

    • Pass the credentials via --user and --password command line arguments.

    • Pass the credentials via the environment variables DEVPI_USER and DEVPI_PASSWORD.

    • Answer the interactive prompt for user and password. This is only possible if --batch is not used.

Version 2.3.1 — 2017-05-19

Changed

  • Improved performance if a blacklist is used.

Version 2.3.0 — 2017-04-07

Added

  • The command line parameter --run-id allows to specify a run identifier that will be added to each entry in the generated JUnit XML.

Changed

Version 2.2.0 — 2016-05-23

Added

  • Capture build errors for better output in case of build failures. Thanks Travis Mehlinger.

Version 2.1.0 — 2016-04-22

Added

  • Support for client certificates. Thanks Hans Lawrenz.

Version 2.0.0 — 2016-01-20

Added

  • Compatibility with pip >= 8.0 by relying on pip’s default download cache mechanism instead of explicitly requiring a download cache. This effectively disables caching for people still using pip < 6.0. Thanks Christian Stefanescu.

  • Support for dry-running the wheel build without changing the devpi server state.

  • Python 3.5 is now officially supported.

Removed

  • Python 3.2 is no longer supported.

Version 1.0.0 — 2015-05-22

Changed

  • Use devpi-plumber instead of a custom devpi wrapper.

  • Check the blacklist first when deciding whether to build a package.

Version 0.4.0 — 2015-09-13

Changed

  • Only consider a package to exist if it is a wheel and it is compatible with the current system. Thanks Michael Still and David Szotten

Fixed

  • The source distribution now properly contains a README.md. Thanks Mikhail Lukyanchenko.

Version 0.3.0 — 2015-08-15

Added

  • Support for special-case handling of pure python wheels

  • Optional support for reporting skipped packages in a JUnit-compatible XML

  • Python 3 support

Version 0.2.1 — 2014-08-07

Fixed

  • Fixed crash if a built wheel could cannot be found (because pip<=1.5.2 skipped it).

Version 0.2.0 — 2014-08-01

Added

  • Support for package blacklisting to never build certain wheels.

Changed

  • build as many packages as possible. Do not stop if one fails.

Version 0.1.0 — 2014-08-01

Added

  • Build a list of packages and upload them to a Devpi index

Metadata

Release files for devpi-builder 7.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for devpi-builder 7.1.0
File Size Uploaded Provenance
devpi_builder-7.1.0.tar.gz 26.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for devpi-builder 7.1.0
File Interpreter ABI Platform
devpi_builder-7.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 38.3 kB

Release files / devpi_builder-7.1.0.tar.gz

Download URL devpi_builder-7.1.0.tar.gz
Size 26.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0208bb7f769f30730cbf1cdcd61dabd424e401c2ae5060a3472af81b6648c81e
BLAKE2b-256 checksum
How to use checksums
59f630ae5ccb0e26dac84f1c934673d24c7de763b137a1f4839a71da5108760e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / devpi_builder-7.1.0-py3-none-any.whl

Download URL devpi_builder-7.1.0-py3-none-any.whl
Size 11.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7a4d8adff4de63fad3e3b21016b75bbcf721545e95ad28b3efe71e3ced84280d
BLAKE2b-256 checksum
How to use checksums
66680ef3a23f57401ec324cce934de595288b9eb521b50243c3ce489c33b4818
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for devpi-builder 7.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page