Python Build Reasonableness
Go to file
Doug Hellmann 19848e6cf1 Clean up links and docs
Move some developer information for running tests out of the README to
the documentation.

Change the home page link to point to the launchpad page.

Add a link to the bug tracker to the README.

Change-Id: I29bdb071eb64bccc561844c130a256b8f998da5f
Closes-Bug: #1318548
2014-10-08 16:49:59 -04:00
doc/source Clean up links and docs 2014-10-08 16:49:59 -04:00
pbr Support reading versions from wheels 2014-09-16 22:40:22 +00:00
tools Remove mirror testing from the integration script 2014-07-10 11:29:59 -07:00
.gitignore Add vim and emacs files to .gitignore. 2013-05-30 02:04:43 -04:00
.gitreview Rename back to PBR. 2013-03-17 23:27:50 -07:00
.mailmap Clean up hacking and path issues with d2to1 2013-07-11 15:02:12 -04:00
.testr.conf Move sphinx to test-reuqirements. 2013-03-12 11:23:43 -04:00
CONTRIBUTING.rst Cosmetic doc fixes. 2013-05-13 18:04:38 +00:00
LICENSE Split out oslo.packaging. 2013-03-10 18:02:43 -04:00
MANIFEST.in Add missing files to the tarball. 2013-05-10 18:41:52 +00:00
README.rst Clean up links and docs 2014-10-08 16:49:59 -04:00
requirements.txt Remove pip version specifier 2014-03-23 08:48:01 -07:00
setup.cfg Clean up links and docs 2014-10-08 16:49:59 -04:00
setup.py Move d2to1 more into the source tree 2013-07-21 10:20:03 -07:00
test-requirements.txt Bump hacking to 0.9.x series 2014-07-22 14:22:57 +02:00
tox.ini Work toward Python 3.4 support and testing 2014-09-03 19:02:56 +00:00

README.rst

Introduction

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.

You can read more in the documentation.

Bugs are tracked using launchpad.