Skip to main content

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
History Node

0.0.7

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
DocUMust-0.0.7-py3-none-any.whl (4.7 kB) Copy SHA256 hash SHA256 Wheel py3 Feb 4, 2017
DocUMust-0.0.7.tar.gz (3.3 kB) Copy SHA256 hash SHA256 Source None Feb 4, 2017

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page