pbr

• Don't wrap develop on newer setuptools
• Fix handling of long_description
• Misc fixes

• Remove use of pkg_resources from tests
• Fix functional test for pip 25.3
• Rename setup.cfg parsing utilities
• Remove remaining uses of pkg_resources
• Inline overridden script writer
• Duplicate methods between ScriptWriter, WindowsScriptWriter
• Remove use of easy_install
• Inline LocalInstallScripts._make_wsgi_scripts_only
• Remove unused code
• Remove dead code
• Pin zuul ansible, pyperclip versions

• util: Deprecate description_file
• util: Skip normalization of description if README opts present
• util: Make handling of description_file clearer
• util: Fix deprecation warnings

Upgrade Notes

Support for the [global] compilers option has been removed. This was an undocumented feature that did not appear to have any use.

The deprecated support for setup.py test has been removed. This feature has been deprecated since version 4.0. The two test tools supported, nose and testr , are no longer maintained, and the general concept of distutils commands is itself deprecated. Users should switch to running the test runners directly and ideally migrate to an alternative, supported test runner like stestr or pytest .

Deprecation Notes

A number of pbr-specific setup.cfg sections and options have been deprecated in order in favour of setuptools native setup.cfg sections and options or their pyproject.toml equivalents:

The [entry_points] section has been deprecated in favour of the [options.entry_points] section (if using setup.cfg ) or the [project.scripts] and/or [project.entry-points.{name}] sections (if using pyproject.toml )

The [files] packages_root option has been deprecated in favour of the [options] package_dir option (if using setup.cfg ) or the [tools.setuptools] package_dir option (if using pyproject.toml )

The [files] packages option has been deprecated in favour of the [options] packages option (if using setup.cfg ) or the [tools.setuptools] packages option (if using pyproject.toml )

The [files] package_data option has been deprecated in favour of the [options.package_data] option (if using setup.cfg ) or the [tool.setuptools.package-data] option (if using pyproject.toml )

The [files] namespace_packages option has been deprecated in favour of the [options] namespace_packages option (if using setup.cfg ). Alternatively, migrate to PEP 420-style namespace packages

The [files] data_files option has been deprecated, and support for non-package data files in general is deprecated in setuptools and their use is discouraged. For package data files, use [options] package_data (if using setup.cfg ) or [tools.setuptools] package_data (if using pyproject.toml ) instead. If non-package data files are necessary, use [options] data_files (if using setup.cfg ) or [tools.setuptools] data-files (if using pyproject.toml ) instead.

The [files] scripts option has been deprecated. There is no direct replacement. Instead, migrate to using the console_scripts entrypoint and use the [options.entry_points] option (if using setup.cfg ) or the [project.scripts] option (if using pyproject.toml ).

The [files] modules option has been deprecated in favour of the [options] py_modules option (if using setup.cfg ) or the [tools.setuptools] py-modules option (if using pyproject.toml )

The [metadata] home_page option has been deprecated in favour of the [metadata] url option (if using setup.cfg ) or the [project.urls] option (if using pyproject.toml )

The [metadata] summary option has been deprecated in favour of the [metadata] description option (if using setup.cfg ) or the [project] description option (if using pyproject.toml )

The [metadata] classifier option has been deprecated in favour of the [metadata] classifiers option (if using setup.cfg ) or the [project] classifiers option (if using pyproject.toml )

The [metadata] platform option has been deprecated in favour of the [metadata] platforms option (if using setup.cfg ) or the [tool.setuptools] platforms (if using pyproject.toml )

The [metadata] requires_dist option has been deprecated in favour of the [options] install_requires option (if using setup.cfg ) or the [project] dependencies option (if using pyproject.toml )

The [metadata] setup_requires_dist option has been deprecated in favour of the [options] setup_requires option (if using setup.cfg ) or the [build-system] requires option (if using pyproject.toml )

The [metadata] python_requires option has been deprecated in favour of the [options] python_requires option (if using setup.cfg ) or the [project] requires-python option (if using pyproject.toml )

The [metadata] requires_python option has been deprecated in favour of the [options] python_requires option (if using setup.cfg ) or the [project] requires-python option (if using pyproject.toml )

The [metadata] provides_dist option has been deprecated as it is obsolete and is no longer used by pip

The [metadata] provides_extra option has been deprecated as it is obsolete and is no longer used by pip

The [metadata] obsoletes_dist option has been deprecated as it is obsolete and is no longer used by pip

The [backwards_compat] zip_safe option has been deprecated as it is was only relevant in the context of eggs and is therefore obsolete

The [backwards_compat] dependency_links option has been deprecated as it is obsolete and is no longer used by pip

The [backwards_compat] tests_require option has been deprecated as it is obsolete and is no longer used by pip

The [backwards_compat] include_package_data option has been deprecated in favour of the [options] include_package_data option (is using setup.cfg ) or the [tools.setuptools] include-package-data option (if using pyproject.toml )

• docs: Drop SetupTools from pyproject.toml example
• Simplify PBR dependency on SetupTools
• Update setup.cfg example in Usage document
• Clarify PEP 517 implementation for users
• Run python release package build job in check and gate

• Set up PBR with setuptools as a dependency
• Use pyproject.toml
• Test pip and setup.py install behavior in PBR testing
• Remove the use of six from PBR
• Fix integration testing of current change
• Update PBR testing for Noble

• Add openstack-tox-py312 as non-voting job
• Add SetupTools to our functional testing venvs
• Use SetupTools' vendored distutils in tests
• Also run coverage tests serially
• zuul: Drop retired repos from required-projects
• Drop Focal integration testing
• Omnibus PBR CI fixups
• Serialize tests
• Fix tempest-full job
• Use summary for the package summary
• Test on py310 and py311

Upgrade Notes

The deprecated support for setup.py build_sphinx has been removed. This feature has been deprecated since version 4.2. Setuptools and sphinx have removed support for this command which breaks PBR’s ability to integrate with those two tools to provide this functionality. Users should switch to building sphinx docs with sphinx directly.

• Run PBR integration on Ubuntu Focal too
• Remove numpy dependencies
• Tie recursion calls to Dist object, not module
• Update tox.ini to work with tox 4

Bug Fixes

Fix an issue where symbols that were indented would produce an incorrect version.

• Specify Changelog procedure
• Allow leading spaces when determining symbols
• Use stdlib importlib.metadata where possible
• Adding python classifiers py38 & py39

• Future-proofing pyproject.toml
• Use importlib-metadata for runtime package version lookups
• Drop wheel from pyproject.toml examples
• Changed minversion in tox to 3.18.0

Bug Fixes

Packages generated with the 5.8.0 release of PBR failed to incorporate pbr.json metadata files. This is now corrected. Users can rebuild packages with newer PBR if they want that missing metadata generated.

• Add python2 testing back to PBR
• Allow PEP517 without setup_requires
• Clarify the need for setup.py with PEP517

New Features

PBR now includes a PEP 517 build-backend and can be used in pyproject.toml build-system configuration. Setuptools continues to be the underlying mechanism with PBR acting as a driver via PEP 517 entrypoints.

• Reverse ordering of 'D1_D2_SETUP_ARGS'
• Add test for cfg -> py transformation
• Don't pass empty 'long_description'
• Move flake8 as a pre-commit local target
• Map requires-python to python-requires (attempt 2)
• Update dependencies to avoid failure with old pip
• Increase OS_TEST_TIMEOUT to 1200
• Prevent test failure due to use of setpref
• util: Convert 'D1_D2_SETUP_ARGS' to a list of tuples
• Revert "Map requires-python to python-requires"
• Dropping lower constraints testing
• Adding pre-commit

Other Notes

The 2to3 conversion utility has been long discouraged in favor of writing multi-version-capable scripts. As of Setuptools 46.2.0 it’s deprecated and slated for removal from the Python 3.10 standard library. Projects which still need it are encouraged to perform conversion prior to packaging. See https://bugs.python.org/issue40360 and https://github.com/pypa/setuptools/issues/2086 for more details.

Other Notes

Support to generate bdist_wininst packages has been removed. As of Python 3.8 and Setuptools 47.2 it’s deprecated in favor of just using wheels for Windows platform packaging. See https://discuss.python.org/t/deprecate-bdist-wininst/ and https://discuss.python.org/t/remove-distutils-bdist-wininst-command/ for more details.

• Switch to Ussuri jobs

• trivial: Use 'open' context manager
• Update to latest hacking
• Mark strings as raw

• Add Python 3 Train unit tests

• Fix parsing on egg names with dashes from git URLs

New Features

Add an option to print only the version of a package

Example:

$ pbr info -s pkgname 1 .2.3

• Resolve some issue with tox.ini, setup.cfg

• Stop using pbr sphinx integration
• Switch to release.o.o for constraints
• Make WSGI tests listen on localhost
• Fix Windows support
• Allow git-tags to be SemVer compliant
• Read description file as utf-8

Bug Fixes

Fixes the handling of spaces in data_files globs. Please see bug 1810934 for more details.

Bug Fixes

Fix error when keywords argument as a cfg list. Previously keywords were CSV_FIELDS and with these changes keywords are now MULTI_FIELDS . Refer to https://bugs.launchpad.net/pbr/+bug/1811475 for more information.

Bug Fixes

Fix mapping error on values who contains a literal = . Example when setup.cfg contains content like the following project urls configuration “project_urls = Documentation = http://foo.bar/?badge=latest ”. https://bugs.launchpad.net/pbr/+bug/1817592

Bug Fixes

Fixes a bug where the directory names of items specified in data_files could be renamed if the source prefix glob was contained within the directory name. See bug 1810804 for details. For more information on data_files , see the distutils documentation .

PBR now ignores --find-links in requirements files. This option is not a valid install_requires entry for setuptools and thus breaks PBR-based installs.

• Fix incorrect use of flake8:noqa
• Correct documentation hyperlink for environment-markers

Bug Fixes

The description-content-type was not being set correctly. It will now be correctly populated when using setuptools 39.2.0 and beyond.

New Features

Subdirectories can now be included when specfifying a requirement in requirements.txt or test-requirements.txt using VCS URIs. For example:

-e git+https://foo.com/zipball#egg=bar&subdirectory=baz

For more information, refer to the pip documentation .

• Deprecate 'test' integration
• Deprecate 'build_sphinx' integration
• Add Sphinx extension
• doc: Add documentation for missing '[pbr]' options
• doc: Fix formatting of packagers guide
• Switch to stestr

• trivial: Fix file permissions
• trivial: Remove 'tools/releasenotes_tox.sh'
• Add docstring from LocalManifestMaker.add_defaults

• Update python3 versions in tox.ini envlist
• fix tox python3 overrides
• Support python-requires metadata

• Revert "Remove win32/nt checks for wrapper script gen"
• Add leading 0 on alpha release in semver doc

• Don't poke in pip for requests
• Fix builddoc with sphinx <= 1.6

• add lower-constraints job
• Explicitly read setup.cfg as utf-8 on Python 3

New Features

Support version parsing of git tag with the v<semver> pattern (or V<semver> ), in addition to <semver> .

Upgrade Notes

Support for entry point command hooks has been removed. This feature was poorly tested, poorly documented, and broken in some environments. Support for global hooks is not affected.

Deprecation Notes

Support for pyN -suffixed requirement files has been deprecated: environment markers should be used instead.

testr and nose integration has been deprecated. This feature allowed pbr to dynamically configure the test runner used when running setup.py test . However, this target has fallen out of favour in both the OpenStack and broader Python ecosystem, and both testr and nose offer native setuptools commands that can be manually aliased to test on a per-project basis, if necessary. This feature will be removed in a future release.

this page last updated: 2025-05-08 14:38:39

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License . See all OpenStack Legal Documents .

found an error? report a bug

OpenStack Documentation

• Guides

• Install Guides

• User Guides

• Configuration Guides

• Operations and Administration Guides

• API Guides

• Contributor Guides

• Languages

• Deutsch (German)

• Français (French)

• Bahasa Indonesia (Indonesian)

• Italiano (Italian)

• 日本語 (Japanese)

• 한국어 (Korean)

• Português (Portuguese)

• Türkçe (Türkiye)

• 简体中文 (Simplified Chinese)

pbr 7.1.2.dev1

• Using pbr

• Features

• Usage

• Notes for Package maintainers

• Linux/Python Compatible Semantic Versioning 3.0.0

• Compatibility Notes

• Release Notes

• CHANGES

• pbr API Reference

• Contributing

Page Contents

• Release Notes

• 7.1.0

• New Features

• 7.0.0

• Upgrade Notes

• Deprecation Notes

• 6.0.0

• Upgrade Notes

• 5.11.0

• Bug Fixes

• 5.8.1

• Bug Fixes

• 5.7.0

• New Features

• 5.5.1

• Other Notes

• 5.5.0

• Other Notes

• 5.4.0

• New Features

• 5.2.1

• Bug Fixes

• 5.2.0

• Bug Fixes

• 5.1.3

• Bug Fixes

• 5.1.2

• Bug Fixes

• 5.0.0

• Bug Fixes

• 4.3.0

• New Features

• 4.0.0

• New Features

• Upgrade Notes

• Deprecation Notes

• Restore previous IP binding
• docs: Don't specify pbr version in 'setup.py'

• allow user to override the output location of api docs
• fix tests based on API change in Sphinx
• Updated from global requirements
• Add binding option for WSGI server
• Ignore index URL lines in requirements.txt files

• builddoc: uses the new Sphinx 1.6 code for multiple builder
• Updated from global requirements
• Fix missing comment from previous change
• trivial: Add note about multiple builders support

• Remove 'build_sphinx_latex'
• Stop building man pages by default
• docs: Use definition lists
• add image.nonlocal_uri to the list of warnings ignored
• doc: Document Sphinx integration
• add changelog to published documentation

• Lazy import pkg_resources
• Add Changelog build handling for invalid chars
• Initialize sphinx config using application instead of config
• Make oslosphinx optional
• Updated from global requirements
• Also generate XML coverage report
• Update to a newer hacking library

• tox: Don't set skipsdist=True
• Stop using 'warnerrors'
• doc: Clarify sections in 'setup.cfg'
• Remove testr entry point
• Updated from global requirements
• Remove discover from test-requirements
• Add Constraints support
• Don't raise exception on missing man pages
• Updated from global requirements
• Clean imports in code
• Updated from global requirements
• Docstrings should not start with a space
• Changed the home-page link
• Update .coveragerc after the removal of openstack directory
• coverage package name option, doc improvement
• Updated from global requirements
• Deprecated warning for SafeConfigParser
• Add more words to a confusing error message
• Don't ignore data-files
• Change assertTrue(isinstance()) by optimal assert
• Fix handling of old git log output
• Fix typo in the index.rst
• Expose deb version to match exposing rpm version
• Replace OpenStack LLC with OpenStack Foundation
• Updated from global requirements
• Fix pypy soabi tests
• Add Python 3.5 classifier and venv
• Fix argument order for assertEqual to (expected, observed)
• Move to oslosphinx
• Updated from global requirements
• Restore warnerrors behavior and support Sphinx 1.4
• Updated from global requirements
• Updated from global requirements
• Updated from global requirements
• Fix pypy wsgi tests
• Remember the insertion order for pbr.json

• File is wrongly marked as executable
• Fix wsgiref script use with oslo.config
• Update Preversioning explanation to avoid double that

• Handle IndexError during version string parsing
• Correct server test

• Updated from global requirements
• Fix soabi tests with pypy
• package: fix wrong catch in email parsing
• Sort 'pbr freeze' output
• Do not convert git tags when searching history
• Include wsgi_scripts in generated wheels
• Correct the indentation in the classifiers example
• Do not silently drop markers that fail to evaluate
• Clarifications around tags and version numbers
• Correct typo - s/enabeld/enabled/
• Use apt-cache generated packages to provide build deps
• fix some variable names
• Don't attempt to test with 0.6c11 with Py3
• Support entry point patching on setuptools < 12
• Updated from global requirements
• Split changelog on nulls instead of (
• Add libjpeg and liberasurecode for tests
• Handle markers to support sdist on pip < 6
• Deprecated tox -downloadcache option removed
• passenv integration environment variables re-enabling integration tests
• Enable pep8 H405 tests
• Add patch to properly get all commands from dist
• doc: Remove 'MANIFEST.in'
• doc: Trivial cleanup of 'index.rst'
• doc: Add deprecation note for 'requirements-pyN'
• doc: Restructure 'Requirements' section
• doc: Restructure 'Usage' section
• doc: Add details of manifest generation
• Support git://, git+ssh://, git+https:// without -e flag
• More support Sphinx >=1.3b1 and <1.3.1
• Fix docs for markers
• Do not error when running pep8 with py3
• Ensure changelog log output is written if it already exists
• Cleanup jeepyb and pypi-mirror special casing

• Handle the case where cmd.distribution has no pbr attribute
• test_integration cleanups
• Remove redundant testscenarios glue
• Add standard code coverage configuration file
• Add shields.io version/downloads links/badges into README.rst

• Strip comments present in setup.cfg
• Protect WSGI application with a critical section

• Have pbr egg_info.writer check PBR is enabled

• Strip comments in requirements files
• Support Sphinx >=1.3 new protoype and warnings

• Handle git being entirely absent
• We require the use of setuptools
• Fix retrieval of commit data and most recent tag

• Fix docs for environment markers in extras
• Export ChangeLog and AUTHORS in install
• Updated from global requirements
• Updated from global requirements
• Show how long the git querying takes
• Add wsgi_scripts support to PBR
• Updated from global requirements