RETIRED, Utilities for projects using pbr
Go to file
David Shrewsbury 221674d1b9 Clear up "tag" vs "image"
We incorrectly reference things in the code as "tags" when what we
really mean is "image". We are only using actual tagging to create
a new prefixed image name that references the original image.

This changes code references from "tag" to "image" in places it
makes sense. Also, we no longer use tagging to create the prefixed
image name, and instead only create the prefixed image and commit
over it, leaving the resulting local images looking much cleaner
(with no duplicates).

Change-Id: I6234a62d927cb9f35f8f4b731eee375f4c208870
2018-08-16 11:42:06 -04:00
doc/source Add documentation about build-images 2018-07-20 13:33:25 -05:00
pbrx Clear up "tag" vs "image" 2018-08-16 11:42:06 -04:00
playbooks/container-images Add image debug print at the end of the job 2018-07-17 00:27:41 +00:00
releasenotes Rename build-containers to build-images 2018-07-08 17:41:16 -04:00
tools Add install-siblings command 2018-04-21 16:07:14 +02:00
.coveragerc Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
.gitignore Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
.gitreview Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
.mailmap Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
.stestr.conf Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
.zuul.yaml Add readthedocs webhook id 2018-08-03 09:26:33 +10:00
CONTRIBUTING.rst Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
HACKING.rst Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
LICENSE Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
README.rst Add documentation about build-images 2018-07-20 13:33:25 -05:00
babel.cfg Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
requirements.txt Add support for building container images from pbr source 2018-04-27 16:17:33 -05:00
setup.cfg Remove python2 2018-07-10 16:27:11 -05:00
setup.py Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
test-requirements.txt Initial Cookiecutter Commit 2018-04-04 16:58:36 -05:00
tox.ini Merge "fix tox python3 overrides" 2018-07-15 10:43:03 +00:00

README.rst

pbrx

Utilities for projects using pbr.

pbr is very opinionated about how things should be done. As a result, there are a set of actions that become easy to deal with generically for any pbr based project. pbrx is a collection of utilities that contain support for such actions.

Note

Each of the utilities has a primary focus of working for projects using pbr. However, some of them will also work just fine for non-pbr-based projects. When that is the case, the utility will be marked appropriately.

Features

Each utility is implemented as a subcommand on the pbrx command.

install-siblings

Updates an installation with local from-source versions of dependencies. For any dependency that the normal installation installed from pip/PyPI, install-siblings will look for an adjacent git repository that provides the same package. If one exists, the source version will be installed to replace the released version. This is done in such a way that any given constraints will be honored and not get messed up by transitive depends.

build-images

Builds container images from a project's source tree. The python:alpine base image is used, and dependencies are taken from bindep.txt for distro requirements and requirements.txt for python requirements. A base image is made for the project itself, and then an additional image based on the base image for every entry in entry_points.console_scripts in the setup.cfg file.