How To Install python-pbr-doc on Ubuntu
Posted on April 1, 2023 (Last modified on May 20, 2023 )
3 minutes • 550 words
Introduction
In this tutorial we learn how to install python-pbr-doc on Ubuntu.
What is python-pbr-doc
python-pbr-doc is:
PBR (Python Build Reasonableness) is a library that injects some useful and sensible default behaviors into your setuptools run. PBR can:
- Manage version number based on git revisions and tags (Version file).
- Generate AUTHORS file from git log
- Generate ChangeLog from git log
- Generate Sphinx autodoc stub files for your whole module
- Store your dependencies in a pip requirements file
- Use your README file as a long_description
- Smartly find packages under your root package
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.
This package provides the documentation.
There are three methods to install python-pbr-doc on Ubuntu. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.
Install python-pbr-doc Using apt-get
Update apt database with apt-get using the following command.
sudo apt-get update
After updating apt database, We can install python-pbr-doc using apt-get by running the following command:
sudo apt-get -y install python-pbr-doc
Install python-pbr-doc Using apt
Update apt database with apt using the following command.
sudo apt update
After updating apt database, We can install python-pbr-doc using apt by running the following command:
sudo apt -y install python-pbr-doc
Install python-pbr-doc Using aptitude
If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Ubuntu. Update apt database with aptitude using the following command.
sudo aptitude update
After updating apt database, We can install python-pbr-doc using aptitude by running the following command:
sudo aptitude -y install python-pbr-doc
How To Uninstall python-pbr-doc on Ubuntu
To uninstall only the python-pbr-doc package we can use the following command:
sudo apt-get remove python-pbr-doc
Uninstall python-pbr-doc And Its Dependencies
To uninstall python-pbr-doc and its dependencies that are no longer needed by Ubuntu, we can use the command below:
sudo apt-get -y autoremove python-pbr-doc
Remove python-pbr-doc Configurations and Data
To remove python-pbr-doc configuration and data from Ubuntu we can use the following command:
sudo apt-get -y purge python-pbr-doc
Remove python-pbr-doc configuration, data, and all of its dependencies
We can use the following command to remove python-pbr-doc configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge python-pbr-doc
Dependencies
python-pbr-doc have the following dependencies:
References
Summary
In this tutorial we learn how to install python-pbr-doc package on Ubuntu using different package management tools: apt, apt-get and aptitude.