run black on documentation code snippets
Project description
blackdoc is a tool that applies black to code in documentation.
It was originally a rewrite of a gist and called black-doctest. In April 2020, it was renamed to blackdoc.
Installation
Dependencies:
Install it with:
python -m pip install blackdocUsage
The commandline interface supports two modes: checking and inplace reformatting.
python -m blackdoc --helpIn inplace reformatting mode, it will reformat the doctest lines and write them back to disk:
# on explicitly mentioned files
python -m blackdoc file1.py file2.py
# on the whole directory
python -m blackdoc .When checking, it will report the changed files but will not write them to disk:
python -m blackdoc --check .It is also possible to use the entrypoint script:
blackdoc --helpRelease 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
blackdoc-0.1.0.tar.gz
(19.2 kB
view details)
Built Distribution
blackdoc-0.1.0-py3-none-any.whl
(19.4 kB
view details)
File details
Details for the file blackdoc-0.1.0.tar.gz.
File metadata
- Download URL: blackdoc-0.1.0.tar.gz
- Upload date:
- Size: 19.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0a35dd9611740b3ce857afed0851ed990027884b66eca1ef815a69225d6fc5ac |
|
| MD5 | f144350727b73542d491c8d1b4c9ae99 |
|
| BLAKE2b-256 | f2de549ae20ec46f12f0f7f339c61da3769c316ca3404a46af6637d7622b969c |
File details
Details for the file blackdoc-0.1.0-py3-none-any.whl.
File metadata
- Download URL: blackdoc-0.1.0-py3-none-any.whl
- Upload date:
- Size: 19.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ecddd10155a892ea9db4fcbed85493e33d6e96acc9c8ccf5ddbfc447ebe5b6ef |
|
| MD5 | da0e33e1683f178f3f55c82f0f677166 |
|
| BLAKE2b-256 | 7faf8c7e67dd30e5b8d6eb719815089a29f79f65b18da051599114f452af5c39 |
