Skip to main content

Python Build Reasonableness

Project description

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.

Running Tests

The testing system is based on a combination of tox and testr. The canonical approach to running tests is to simply run the command tox. This will create virtual environments, populate them with dependencies and run all of the tests that OpenStack CI systems run. Behind the scenes, tox is running testr run --parallel, but is set up such that you can supply any additional testr arguments that are needed to tox. For example, you can run: tox -- --analyze-isolation to cause tox to tell testr to add --analyze-isolation to its argument list.

It is also possible to run the tests inside of a virtual environment you have created, or it is possible that you have all of the dependencies installed locally already. If you’d like to go this route, the requirements are listed in requirements.txt and the requirements for testing are in test-requirements.txt. Installing them via pip, for instance, is simply:

pip install -r requirements.txt -r test-requirements.txt

In you go this route, you can interact with the testr command directly. Running testr run will run the entire test suite. testr run --parallel will run it in parallel (this is the default incantation tox uses). More information about testr can be found at: http://wiki.openstack.org/testr

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pbr-0.10.2.tar.gz (79.5 kB view details)

Uploaded Source

Built Distribution

pbr-0.10.2-py2.py3-none-any.whl (63.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pbr-0.10.2.tar.gz.

File metadata

  • Download URL: pbr-0.10.2.tar.gz
  • Upload date:
  • Size: 79.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pbr-0.10.2.tar.gz
Algorithm Hash digest
SHA256 f16f31839b293b3cf48ed3b34768b647743c3435e218c90d59ca9d1d27455bf8
MD5 3f57d706d96b8790b5f2998fd71f2273
BLAKE2b-256 2d5d85559fcd563b1567502d45d6a193839e22661cbea0c1663636cf10e3b4ce

See more details on using hashes here.

Provenance

File details

Details for the file pbr-0.10.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pbr-0.10.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 22c3f4a8c91dc2d2e99271d662b72cfeb90ec436ca0553ece620ae8576096a2b
MD5 ad53e06117b823fd1614acc6f5e43335
BLAKE2b-256 c239653746d50ebd66a8784c5469e439e73b717f48fa463165d7c734d25a2de6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page