diff options
| author | Monty Taylor <mordred@inaugust.com> | 2013-03-17 23:27:50 -0700 |
|---|---|---|
| committer | Monty Taylor <mordred@inaugust.com> | 2013-03-17 23:27:50 -0700 |
| commit | e8af43a31805e933391f93954256c9c15f188407 (patch) | |
| tree | 57f09999e884b01f0d2d8d278312455d5a2c2f97 /README.rst | |
| parent | eaef2c9be50b09708b86466822e5275fe154edbf (diff) | |
| download | pbr-e8af43a31805e933391f93954256c9c15f188407.tar.gz | |
Rename back to PBR.
Change-Id: I13ee7fab7858231b0fa17f9116176a09184e8b0e
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 17 |
1 files changed, 8 insertions, 9 deletions
@@ -1,7 +1,7 @@ Introduction ============ -oslo.packaging provides a set of default python packaging configuration and +pbr provides a set of default python packaging configuration and behaviors. It is implemented as a setup hook for d2to1 which allows us to manipulate the setup.cfg information before it is passed to setup.py. @@ -23,14 +23,14 @@ into the sphinx config. Usage ===== -oslo.packaging requires a distribution to use distribute. Your distribution +pbr requires a distribution to use distribute. Your distribution must include a distutils2-like setup.cfg file, and a minimal setup.py script. -A simple sample can be found in oslo.packaging s own setup.cfg +A simple sample can be found in pbr s own setup.cfg (it uses its own machinery to install itself):: [metadata] - name = oslo.packaging + name = pbr author = OpenStack Foundation author-email = openstack-dev@lists.openstack.org summary = OpenStack's setup automation in a reuable form @@ -51,10 +51,9 @@ A simple sample can be found in oslo.packaging s own setup.cfg [files] packages = oslo - oslo.packaging [hooks] setup-hooks = - oslo.packaging.hooks.setup_hook + pbr.hooks.setup_hook The minimal setup.py should look something like this:: @@ -63,12 +62,12 @@ The minimal setup.py should look something like this:: from setuptools import setup setup( - setup_requires=['d2to1', 'oslo.packaging'], + setup_requires=['d2to1', 'pbr'], d2to1=True, ) -Note that it's important to specify `d2to1=True` or else the -oslo.packaging functionality will not be enabled. +Note that it's important to specify `d2to1=True` or else the pbr functionality +will not be enabled. It should also work fine if additional arguments are passed to `setup()`, but it should be noted that they will be clobbered by any options in the |