Lets make sure you don't forget to document this time.
Project description
# 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
DocUMust-0.0.7.tar.gz
(3.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file DocUMust-0.0.7.tar.gz.
File metadata
- Download URL: DocUMust-0.0.7.tar.gz
- Upload date:
- Size: 3.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ace2fef7fa219baaebb1f704b338116aa8b1852fc05ae871a796829fa3f37aa8
|
|
| MD5 |
dba8fcf30a0d8fe301d5e3f9049c8df8
|
|
| BLAKE2b-256 |
3234196291c1fbce9f97e26c1cb1b130ec48f11fe163da2298fe413ba46c29be
|
File details
Details for the file DocUMust-0.0.7-py3-none-any.whl.
File metadata
- Download URL: DocUMust-0.0.7-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73727bfb3e3a58fc39e75511fad36e13202040b35114d89fcbfb805d153734eb
|
|
| MD5 |
0e7099dec0b359bcc342ce18bfa4e28c
|
|
| BLAKE2b-256 |
70dbe4a9ba2d0072f4e1006f4cbce38da15bed2c08021bac350108c3ddc6368c
|
