Python Build Reasonableness (LADI project)
Go to file
Chris Dohmen 1eadf23b94 Specify Changelog procedure
Update the CONTRIBUTING file to specify how release notes are managed.
This allows contributors to follow best-practices to ensure the
auto-generated Changelog stays up-to-date.

Change-Id: I7902c33a76c4cce8f50307843476e5d9435c9e2c
2022-06-13 17:06:43 -04:00
doc Drop wheel from pyproject.toml examples 2022-02-28 14:35:37 +00:00
pbr Allow leading spaces when determining symbols 2022-06-03 09:21:25 -04:00
playbooks/pbr-installation-openstack Cleanup old legacy devstack-gate jobs 2020-08-06 10:41:29 -07:00
releasenotes Add release note about missing pbr.json fix 2022-02-05 16:06:59 +00:00
tools Increase OS_TEST_TIMEOUT to 1200 2021-04-01 11:37:53 +01:00
.coveragerc Update .coveragerc after the removal of openstack directory 2016-10-19 15:16:29 +05:30
.gitignore Add Release Notes to documentation 2020-08-11 21:20:17 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:17 +00:00
.mailmap Clean up hacking and path issues with d2to1 2013-07-11 15:02:12 -04:00
.pre-commit-config.yaml Upgrade the pre-commit-hooks version 2021-05-18 11:17:07 +08:00
.stestr.conf Switch to stestr 2018-07-18 10:12:17 +01:00
.zuul.yaml Add python2 testing back to PBR 2021-11-12 10:01:14 -08:00
CONTRIBUTING.rst Specify Changelog procedure 2022-06-13 17:06:43 -04:00
LICENSE Split out oslo.packaging. 2013-03-10 18:02:43 -04:00
README.rst Add Release Notes to documentation 2020-08-11 21:20:17 +00:00
pyproject.toml.future Future-proofing pyproject.toml 2022-03-28 11:01:23 +00:00
setup.cfg Adding python classifiers py38 & py39 2022-05-05 12:06:18 +02:00
setup.py trivial: Fix file permissions 2018-07-18 10:12:17 +01:00
test-requirements.txt remove explicit mock 2022-01-21 10:44:41 +01:00
tox.ini Changed minversion in tox to 3.18.0. 2022-02-16 12:05:40 +01:00

README.rst

Introduction
============

.. image:: https://img.shields.io/pypi/v/pbr.svg
    :target: https://pypi.python.org/pypi/pbr/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/dm/pbr.svg
    :target: https://pypi.python.org/pypi/pbr/
    :alt: Downloads

PBR is a library that injects some useful and sensible default behaviors
into your setuptools run. It started off life as the chunks of code that
were copied between all of the `OpenStack`_ projects. Around the time that
OpenStack hit 18 different projects each with at least 3 active branches,
it seemed like a good time to make that code into a proper reusable library.

PBR is only mildly configurable. The basic idea is that there's a decent
way to run things and if you do, you should reap the rewards, because then
it's simple and repeatable. If you want to do things differently, cool! But
you've already got the power of Python at your fingertips, so you don't
really need PBR.

PBR builds on top of the work that `d2to1`_ started to provide for declarative
configuration. `d2to1`_ is itself an implementation of the ideas behind
`distutils2`_. Although `distutils2`_ is now abandoned in favor of work towards
`PEP 426`_ and Metadata 2.0, declarative config is still a great idea and
specifically important in trying to distribute setup code as a library
when that library itself will alter how the setup is processed. As Metadata
2.0 and other modern Python packaging PEPs come out, PBR aims to support
them as quickly as possible.

* License: Apache License, Version 2.0
* Documentation: https://docs.openstack.org/pbr/latest/
* Source: https://opendev.org/openstack/pbr
* Bugs: https://bugs.launchpad.net/pbr
* Release Notes: https://docs.openstack.org/pbr/latest/user/releasenotes.html
* ChangeLog: https://docs.openstack.org/pbr/latest/user/history.html

.. _d2to1: https://pypi.python.org/pypi/d2to1
.. _distutils2: https://pypi.python.org/pypi/Distutils2
.. _PEP 426: http://legacy.python.org/dev/peps/pep-0426/
.. _OpenStack: https://www.openstack.org/