Skip to main content

"devpi-constrained: an index for devpi-server that provides a constrained list of packages from it's bases"

Project description

devpi-constrained: releases filter for devpi-server

This plugin adds a constrained index to devpi-server. The constrained index is read-only and filters releases from its bases similar to Constraints Files in pip.

Installation

devpi-constrained needs to be installed alongside devpi-server to enable constrained indexes.

You can install it with:

pip install devpi-constrained

There is no configuration needed as devpi-server will automatically discover the plugin through calling hooks using the setuptools entry points mechanism.

Motivation

It is often useful to filter Python packages available for installation. For example:

  • Filter package versions with known security issues

  • Provide a “Known Good Set” of packages which have been tested

  • Prevent installation of packages with incompatible licenses

  • Only allowing vetted packages

  • Block package versions with breaking changes

With devpi-constrained it is possible to provide a package index which enables all of the above and more.

Usage

Create a constrained index with root/pypi as base:

$ devpi index -c prod/devpi type=constrained bases=root/pypi
https://example.com/prod/devpi:
  type=constrained
  bases=root/pypi
  volatile=True
  acl_upload=root
  acl_toxresult_upload=:ANONYMOUS:
  constraints=
  mirror_whitelist=

$ devpi use prod/devpi

With no constraints set, all releases are available from root/pypi.

Lets add a constraint for pip:

$ devpi index constraints+="pip==6.0"
/prod/devpi constraints+=pip==6.0
https://example.com/prod/devpi?no_projects=:
  type=constrained
  bases=root/pypi
  volatile=True
  acl_upload=root
  acl_toxresult_upload=:ANONYMOUS:
  constraints=pip==6.0
  mirror_whitelist=

Now only pip 6.0 will be listed when looking for releases of pip:

$ devpi list --all pip
http://localhost:3141/root/pypi/+f/610/3897f1bb68d3f/pip-6.0.tar.gz
http://localhost:3141/root/pypi/+f/5ec/6732505bd8be4/pip-6.0-py2.py3-none-any.whl

All other packages are still unconstrained.

To block everything else we add the * constraint:

$ devpi index constraints+="*"
/prod/devpi constraints+=*
https://example.com/prod/devpi?no_projects=:
  type=constrained
  bases=root/pypi
  volatile=True
  acl_upload=root
  acl_toxresult_upload=:ANONYMOUS:
  constraints=pip==6.0,*
  mirror_whitelist=

This is the difference to pip constraints, where this isn’t possible.

$ devpi list --all devpi-server
GET https://example.com/prod/devpi/devpi-server/
404 Not Found: no project 'devpi-server'

The constraints option can be set in bulk from a file. Create a file constraints.txt with each constraint in one line:

pip<8,>4
# a comment
devpi-server>=4

Set the constraints option on your index from the file:

$ devpi index constraints="$(cat constraints.txt)"

Legacy versions

Support for legacy (non PEP440) versions is limited. When the constraint contains any filtering on the version, then no legacy version will pass. Technically legacy versions sort before any PEP440 compliant version, but the packaging library doesn’t expose the operator publicly in an easily usable way, so this compromise was chosen to not have to deal with possibly changing internals.

Changelog

2.1.0 - 2026-05-08

  • With devpi-server 7.0.0 filtering when inheriting from a constrained index works as expected. [fschulze]

  • Fix version filtering with “*” (all) constraint. [fschulze]

  • Rudimentary support for legacy (non PEP440) versions. [fschulze]

  • Require devpi-server >= 6.10.0. [fschulze]

  • Add support for Python 3.12, 3.13 and 3.14. [fschulze]

  • Fix devpi import/export [amoutaux (Aurélien Moutaux)]

2.0.1 - 2023-03-18

  • Fix filtering of simple links page. [EvaSDK (Gilles Dartiguelongue)]

2.0.0 - 2023-02-21

  • Remove support for Python <= 3.6. [fschulze]

  • Add testing for Python 3.8, 3.9, 3.10, 3.11 and PyPy-3.7. [fschulze]

  • Require devpi-server >= 6.2.0. [fschulze]

1.0.0 - 2019-08-05

  • Initial release. [fschulze (Florian Schulze)]

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

devpi_constrained-2.1.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

devpi_constrained-2.1.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file devpi_constrained-2.1.0.tar.gz.

File metadata

  • Download URL: devpi_constrained-2.1.0.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: devpi-server/6.19.1 (py3.11.11; darwin)

File hashes

Hashes for devpi_constrained-2.1.0.tar.gz
Algorithm Hash digest
SHA256 c99839ea95fd5225e3d87c8dad234c1c965bfb05da42b50e428e738c5395a6c8
MD5 63f919f4f8076c1f865c6e3fd1780a92
BLAKE2b-256 3ebfee710fff23953fdfe883c8e14a810bb4c35229e2549004c23fb7ebe711cc

See more details on using hashes here.

File details

Details for the file devpi_constrained-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: devpi_constrained-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: devpi-server/6.19.1 (py3.11.11; darwin)

File hashes

Hashes for devpi_constrained-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32ce70315e084564cbb537c77560be4e8b3d8a115c8cd2be51cec22d2360c2f5
MD5 89e079f1c0db411355053bb14bdf51ff
BLAKE2b-256 b2f2724ec6db68063b1f2f585c4c1ee071ca62e130f7483954568b45905c551c

See more details on using hashes here.

Supported by

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