How To Install python-os-api-ref on Debian 10
Introduction
In this tutorial we learn how to install python-os-api-ref on Debian 10.
What is python-os-api-ref
python-os-api-ref is:
This project is a collection of sphinx stanzas that assist in building an API Reference site for an OpenStack project in RST. RST is great for unstructured English, but displaying semi structured (and repetitive) data in tables is not it’s strength. This provides tooling to insert semi-structured data describing request and response parameters, and turn those into nice tables.
The project also includes a set of styling (and javascript) that is expected to layer on top of an oslosphinx theme base. This provides a nice set of collapsing sections for REST methods and javascript controls to expand / collapse all sections.
This package contains the Python 2.7 module.
There are three methods to install python-os-api-ref on Debian 10. 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-os-api-ref 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-os-api-ref using apt-get by running the following command:
sudo apt-get -y install python-os-api-ref
Install python-os-api-ref Using apt
Update apt database with apt using the following command.
sudo apt update
After updating apt database, We can install python-os-api-ref using apt by running the following command:
sudo apt -y install python-os-api-ref
Install python-os-api-ref 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 Debian. Update apt database with aptitude using the following command.
sudo aptitude update
After updating apt database, We can install python-os-api-ref using aptitude by running the following command:
sudo aptitude -y install python-os-api-ref
How To Uninstall python-os-api-ref on Debian 10
To uninstall only the python-os-api-ref package we can use the following command:
sudo apt-get remove python-os-api-ref
Uninstall python-os-api-ref And Its Dependencies
To uninstall python-os-api-ref and its dependencies that are no longer needed by Debian 10, we can use the command below:
sudo apt-get -y autoremove python-os-api-ref
Remove python-os-api-ref Configurations and Data
To remove python-os-api-ref configuration and data from Debian 10 we can use the following command:
sudo apt-get -y purge python-os-api-ref
Remove python-os-api-ref configuration, data, and all of its dependencies
We can use the following command to remove python-os-api-ref configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge python-os-api-ref
Dependencies
python-os-api-ref have the following dependencies:
- python-docutils
- python-openstackdocstheme
- python-os-api-ref-common
- python-pbr
- python-six
- python-sphinx
- python-yaml
- python
References
Summary
In this tutorial we learn how to install python-os-api-ref package on Debian 10 using different package management tools: apt, apt-get and aptitude.