nwdocstringchecking

Introduction

This packages consists of the following modules:

• nwdocstringchecking is a library designed to identify which methods in a Python file are missing docstrings.
• nwdocstringcheckingcli is a command-line application built on the top of nwdocstringchecking.

Getting Started

I'll use Debian as operating system, but the concept is similar for Windows or Mac.

Procedure:

1. Install pip and venv:

sudo apt install python3-pip python3.12-venv

2. Create a virtual environment:

python3 -m venv /tmp/nwdocstringchecking
source /tmp/nwdocstringchecking/bin/activate

3. Download and install the package:

pip install nwdocstringchecking

4. Enter in the interactive Python environment:

python3

Python 3.12.3 (main, Aug 31 2026, 10:18:26) [GCC 13.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>

5. Try out if the library works:

from nwdocstringchecking import DocStringChecker

docstring_checker : DocStringChecker = DocStringChecker()

6. Exit from the interactive Python environment:

exit()

7. Try out if the CLI application works:

nwdocstringcheckingcli

8. Deactivate and delete the virtual environment:

deactivate
rm -rf /tmp/nwdocstringchecking

9. Done!

Examples

Run it against a file_path:

nwdocstringcheckingcli --file_path src/nwdocstringchecking.py

*******************************************
'##::: ##:'##:::::'##:'########:::'######::
 ###:: ##: ##:'##: ##: ##.... ##:'##... ##:
 ####: ##: ##: ##: ##: ##:::: ##: ##:::..::
 ## ## ##: ##: ##: ##: ##:::: ##:. ######::
 ##. ####: ##: ##: ##: ##:::: ##::..... ##:
 ##:. ###: ##: ##: ##: ##:::: ##:'##::: ##:
 ##::. ##:. ###. ###:: ########::. ######::
..::::..:::...::...:::........::::......:::
************************Version: 2.0.1*****

file_path: 'src/nwdocstringchecking.py'
exclude: '[]'

_MessageCollectionValidator.provided_file_path_doesnt_exist

Run it against a file_path with exclude:

nwdocstringcheckingcli 	--file_path src/nwdocstringchecking.py 	--exclude Message 	--exclude Something

*******************************************
'##::: ##:'##:::::'##:'########:::'######::
 ###:: ##: ##:'##: ##: ##.... ##:'##... ##:
 ####: ##: ##: ##: ##: ##:::: ##: ##:::..::
 ## ## ##: ##: ##: ##: ##:::: ##:. ######::
 ##. ####: ##: ##: ##: ##:::: ##::..... ##:
 ##:. ###: ##: ##: ##: ##:::: ##:'##::: ##:
 ##::. ##:. ###. ###:: ########::. ######::
..::::..:::...::...:::........::::......:::
************************Version: 2.0.1*****

file_path: 'src/nwdocstringchecking.py'
exclude: '['Message', 'Something']'

All methods have docstrings.

Links

• Source: https://github.com/numbworks/nwdocstringchecking
• License: https://github.com/numbworks/nwdocstringchecking/blob/master/LICENSE

Total Downloads (PyPi)