How To Install python-os-api-ref-common on Ubuntu 18.04

In this tutorial we learn how to install python-os-api-ref-common on Ubuntu 18.04. python-os-api-ref-common is Sphinx Extensions to support API reference sites in OpenStack - common

Introduction

In this tutorial we learn how to install python-os-api-ref-common on Ubuntu 18.04.

What is python-os-api-ref-common

python-os-api-ref-common 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 common files.

There are three methods to install python-os-api-ref-common 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 python-os-api-ref-common 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-common using apt-get by running the following command:

sudo apt-get -y install python-os-api-ref-common

Install python-os-api-ref-common 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-common using apt by running the following command:

sudo apt -y install python-os-api-ref-common

Install python-os-api-ref-common 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-os-api-ref-common using aptitude by running the following command:

sudo aptitude -y install python-os-api-ref-common

How To Uninstall python-os-api-ref-common on Ubuntu 18.04

To uninstall only the python-os-api-ref-common package we can use the following command:

sudo apt-get remove python-os-api-ref-common

Uninstall python-os-api-ref-common And Its Dependencies

To uninstall python-os-api-ref-common and its dependencies that are no longer needed by Ubuntu 18.04, we can use the command below:

sudo apt-get -y autoremove python-os-api-ref-common

Remove python-os-api-ref-common Configurations and Data

To remove python-os-api-ref-common configuration and data from Ubuntu 18.04 we can use the following command:

sudo apt-get -y purge python-os-api-ref-common

Remove python-os-api-ref-common configuration, data, and all of its dependencies

We can use the following command to remove python-os-api-ref-common configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge python-os-api-ref-common

References

Summary

In this tutorial we learn how to install python-os-api-ref-common package on Ubuntu 18.04 using different package management tools: apt, apt-get and aptitude.