Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Project details


Release history Release notifications

This version

0.0.7

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for DocUMust, version 0.0.7
Filename, size File type Python version Upload date Hashes
Filename, size DocUMust-0.0.7-py3-none-any.whl (4.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size DocUMust-0.0.7.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page