From dc195881ba07a2a5c5c798fc92e2b09d81bec70c Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Sun, 17 Mar 2013 23:27:50 -0700 Subject: [PATCH] Rename back to PBR. Change-Id: I13ee7fab7858231b0fa17f9116176a09184e8b0e --- .gitreview | 2 +- README.rst | 17 ++++++++--------- doc/source/conf.py | 2 +- doc/source/index.rst | 9 +++++---- pbr/tests/__init__.py | 14 ++++++++++++++ setup.cfg | 10 ++++------ tox.ini | 7 +++++-- 7 files changed, 38 insertions(+), 23 deletions(-) create mode 100644 pbr/tests/__init__.py diff --git a/.gitreview b/.gitreview index 9673b81..8df2996 100644 --- a/.gitreview +++ b/.gitreview @@ -1,4 +1,4 @@ [gerrit] host=review.openstack.org port=29418 -project=openstack/oslo.packaging.git +project=openstack-dev/pbr.git diff --git a/README.rst b/README.rst index a06866d..8a2eb62 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 5fb0c34..385f5e0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,7 +24,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'oslo.packaging' +project = u'pbr' copyright = u'2013, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. diff --git a/doc/source/index.rst b/doc/source/index.rst index ab6f972..75e69ca 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,8 +1,9 @@ -oslo.packaging -============== +pbr - Python Build Reasonableness +================================= -An OpenStack library for managing setuptools packaging needs in a consistent -manner. +A library for managing setuptools packaging needs in a consistent manner. + +PBR is not a library about beer. Contents -------- diff --git a/pbr/tests/__init__.py b/pbr/tests/__init__.py new file mode 100644 index 0000000..f745a13 --- /dev/null +++ b/pbr/tests/__init__.py @@ -0,0 +1,14 @@ +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/setup.cfg b/setup.cfg index ae4f243..c34709f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,11 +1,11 @@ [metadata] -name = oslo.packaging +name = pbr author = OpenStack author-email = openstack-dev@lists.openstack.org summary = OpenStack's setup automation in a reusable form description-file = README.rst -home-page = http://pypi.python.org/pypi/oslo.packaging +home-page = http://pypi.python.org/pypi/pbr classifier = Development Status :: 4 - Beta Environment :: Console @@ -18,10 +18,8 @@ classifier = [files] packages = - oslo -namespace_packages = - oslo + pbr [global] setup-hooks = - oslo.packaging.hooks.setup_hook + pbr.hooks.setup_hook diff --git a/tox.ini b/tox.ini index 18e9db3..3d7ff82 100644 --- a/tox.ini +++ b/tox.ini @@ -16,8 +16,7 @@ sitepackages = True downloadcache = ~/cache/pip [testenv:pep8] -commands = - pep8 --repeat --show-source --exclude=.venv,.tox,dist,doc,*.egg . +commands = flake8 [testenv:pyflakes] deps = pyflakes @@ -30,3 +29,7 @@ commands = [testenv:venv] commands = {posargs} + +[flake8] +exclude = .venv,.tox,dist,doc,*.egg +show-source = true