How To Install pydocstyle on Ubuntu
Posted on April 1, 2023 (Last modified on May 20, 2023 )
2 minutes • 379 words
Introduction
In this tutorial we learn how to install pydocstyle on Ubuntu.
What is pydocstyle
pydocstyle is:
PEP-257 provides conventions for Python docstrings (string literals which occur as first statement in a module, function, class or method definition for documentation purposes). This tool checks Python code whether these conventions have been complied with, and if docstring are missing.
This is a successor of the application “pep257”.
This package installs the cli tool.
There are three methods to install pydocstyle 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 pydocstyle Using apt-get
Update apt database with apt-get using the following command.
sudo apt-get update
After updating apt database, We can install pydocstyle using apt-get by running the following command:
sudo apt-get -y install pydocstyle
Install pydocstyle Using apt
Update apt database with apt using the following command.
sudo apt update
After updating apt database, We can install pydocstyle using apt by running the following command:
sudo apt -y install pydocstyle
Install pydocstyle 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 pydocstyle using aptitude by running the following command:
sudo aptitude -y install pydocstyle
How To Uninstall pydocstyle on Ubuntu
To uninstall only the pydocstyle package we can use the following command:
sudo apt-get remove pydocstyle
Uninstall pydocstyle And Its Dependencies
To uninstall pydocstyle and its dependencies that are no longer needed by Ubuntu, we can use the command below:
sudo apt-get -y autoremove pydocstyle
Remove pydocstyle Configurations and Data
To remove pydocstyle configuration and data from Ubuntu we can use the following command:
sudo apt-get -y purge pydocstyle
Remove pydocstyle configuration, data, and all of its dependencies
We can use the following command to remove pydocstyle configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge pydocstyle
Dependencies
pydocstyle have the following dependencies:
References
Summary
In this tutorial we learn how to install pydocstyle package on Ubuntu using different package management tools: apt, apt-get and aptitude.