How To Install python3-os-api-ref on Ubuntu 18.04
Introduction
In this tutorial we learn how to install python3-os-api-ref on Ubuntu 18.04.
What is python3-os-api-ref
python3-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 3.x module.
There are three methods to install python3-os-api-ref on Ubuntu 18.04. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.
Install python3-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 python3-os-api-ref using apt-get by running the following command:
sudo apt-get -y install python3-os-api-ref
Install python3-os-api-ref Using apt
Update apt database with apt using the following command.
sudo apt update
After updating apt database, We can install python3-os-api-ref using apt by running the following command:
sudo apt -y install python3-os-api-ref
Install python3-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 Ubuntu. Update apt database with aptitude using the following command.
sudo aptitude update
After updating apt database, We can install python3-os-api-ref using aptitude by running the following command:
sudo aptitude -y install python3-os-api-ref
How To Uninstall python3-os-api-ref on Ubuntu 18.04
To uninstall only the python3-os-api-ref package we can use the following command:
sudo apt-get remove python3-os-api-ref
Uninstall python3-os-api-ref And Its Dependencies
To uninstall python3-os-api-ref and its dependencies that are no longer needed by Ubuntu 18.04, we can use the command below:
sudo apt-get -y autoremove python3-os-api-ref
Remove python3-os-api-ref Configurations and Data
To remove python3-os-api-ref configuration and data from Ubuntu 18.04 we can use the following command:
sudo apt-get -y purge python3-os-api-ref
Remove python3-os-api-ref configuration, data, and all of its dependencies
We can use the following command to remove python3-os-api-ref configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge python3-os-api-ref
References
Summary
In this tutorial we learn how to install python3-os-api-ref package on Ubuntu 18.04 using different package management tools: apt, apt-get and aptitude.
