Python package leveraging doq, black, pylint, mypy and sphinx to automatically clean and document python code.
Reason this release was yanked:
bugs
Project description
cleandoc
Python package leveraging doq, black, pylint, mypy and sphinx to automatically clean and document python code.
Install
pip install cleandoc
Usage
cleandoc [-h] [-file FILE] [-dir DIR] [-write] [-ignore] [-noclean] [-nodoc]
optional arguments:
-h, --help
show this help message and exit
-file FILE,-f FILE
Python (.py) file to clean
-dir DIR, -d DIR
Directory containing Python (.py) files to clean and/or document
-write, -w
Flag to write changes to files in-place
-ignore, -i
Flag to continue through warnings
-noclean, -nc
Flag to prevent cleaning of py files
-nodoc, -nd
Flag to prevent html doc creation\
Read The Docs
Download "docs" folder or check preview.
Contributing
Message me on Github.
License
Copyright:
(c) 2023, Jason Krist
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
Built Distribution
File details
Details for the file cleandoc-0.0.2.tar.gz.
File metadata
- Download URL: cleandoc-0.0.2.tar.gz
- Upload date:
- Size: 23.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1cefdad2f428722f0b7f141967598fbf214a548335c5f9f6be5d6a5d56d5c8ad |
|
| MD5 | b94670dd47b58646f8f6998778ff2171 |
|
| BLAKE2b-256 | 58d0da795d9eaaf55e3d5798f02b8fd096f1cc3d611461c1cd2ebd0023f1b333 |
File details
Details for the file cleandoc-0.0.2-py3-none-any.whl.
File metadata
- Download URL: cleandoc-0.0.2-py3-none-any.whl
- Upload date:
- Size: 27.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c2181d84b56068b77b50e281f87c2607890f5bb438e09e5ce23852d3153048dd |
|
| MD5 | 8e8237e27892c5ff753daaa99bdfc0df |
|
| BLAKE2b-256 | fda4f03471c57dab62ac8da7a5874b8e54fc78dc500963c0650eb20622e96a0f |
