How To Install python3-docformatter on Ubuntu 22.04
Introduction
In this tutorial we learn how to install python3-docformatter
on Ubuntu 22.04.
What is python3-docformatter
python3-docformatter is:
Docformatter currently automatically formats docstrings to follow a subset of the PEP 257 conventions.
Below are the relevant items quoted from PEP 257:
- For consistency, always use triple double quotes around docstrings,
- Triple quotes are used even though the string fits on one line,
- Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description,
- Unless the entire docstring fits on a line, place the closing quotes on a line by themselves.
Docformatter also handles some of the PEP 8 conventions:
- Don’t write string literals that rely on significant trailing whitespace Such trailing whitespace is visually indistinguishable and some editors (or more recently, reindent.py) will trim them.
This package installs the library for Python 3.
There are three methods to install python3-docformatter
on Ubuntu 22.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-docformatter 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-docformatter
using apt-get
by running the following command:
sudo apt-get -y install python3-docformatter
Install python3-docformatter Using apt
Update apt database with apt
using the following command.
sudo apt update
After updating apt database, We can install python3-docformatter
using apt
by running the following command:
sudo apt -y install python3-docformatter
Install python3-docformatter 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-docformatter
using aptitude
by running the following command:
sudo aptitude -y install python3-docformatter
How To Uninstall python3-docformatter on Ubuntu 22.04
To uninstall only the python3-docformatter
package we can use the following command:
sudo apt-get remove python3-docformatter
Uninstall python3-docformatter And Its Dependencies
To uninstall python3-docformatter
and its dependencies that are no longer needed by Ubuntu 22.04, we can use the command below:
sudo apt-get -y autoremove python3-docformatter
Remove python3-docformatter Configurations and Data
To remove python3-docformatter
configuration and data from Ubuntu 22.04 we can use the following command:
sudo apt-get -y purge python3-docformatter
Remove python3-docformatter configuration, data, and all of its dependencies
We can use the following command to remove python3-docformatter
configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge python3-docformatter
References
Summary
In this tutorial we learn how to install python3-docformatter
package on Ubuntu 22.04 using different package management tools: apt
, apt-get
and aptitude
.