# DocUMust
#### Lets make sure you don't forget to document this time.
- [About](#about)
- [Usage](#usage)
- [Installation](#installation)
## About
<b>DocUMust</b> is a CLI tool that warns you about
undocumented modules/classes/functions in your project
following [PEP 257](#https://www.python.org/dev/peps/pep-0257)
guidelines.
<p align="center">
<img src="" alt="DocUMust Demo gif"/>
</p>
## Installation
You can install <b>documust</b> with pip:
> pip install documust
## Usage
> cd Project/
>
> documust -r
## Options
- -r: Run recursively over your project
#### Lets make sure you don't forget to document this time.
- [About](#about)
- [Usage](#usage)
- [Installation](#installation)
## About
<b>DocUMust</b> is a CLI tool that warns you about
undocumented modules/classes/functions in your project
following [PEP 257](#https://www.python.org/dev/peps/pep-0257)
guidelines.
<p align="center">
<img src="" alt="DocUMust Demo gif"/>
</p>
## Installation
You can install <b>documust</b> with pip:
> pip install documust
## Usage
> cd Project/
>
> documust -r
## Options
- -r: Run recursively over your project
1 maintainer
Release files for DocUMust 0.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| DocUMust-0.0.7.tar.gz | 3.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| DocUMust-0.0.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.0 kB
Release files / DocUMust-0.0.7.tar.gz
| Download URL | DocUMust-0.0.7.tar.gz |
|---|---|
| Size | 3.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ace2fef7fa219baaebb1f704b338116aa8b1852fc05ae871a796829fa3f37aa8
|
|
BLAKE2b-256 checksum How to use checksums |
3234196291c1fbce9f97e26c1cb1b130ec48f11fe163da2298fe413ba46c29be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / DocUMust-0.0.7-py3-none-any.whl
| Download URL | DocUMust-0.0.7-py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
73727bfb3e3a58fc39e75511fad36e13202040b35114d89fcbfb805d153734eb
|
|
BLAKE2b-256 checksum How to use checksums |
70dbe4a9ba2d0072f4e1006f4cbce38da15bed2c08021bac350108c3ddc6368c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
