run black on documentation code snippets

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for keewis from gravatar.com keewis

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Justus Magin
  • Requires: Python >=3.6
Classifiers

Project description

https://github.com/keewis/blackdoc/workflows/CI/badge.svg?branch=master https://img.shields.io/badge/code%20style-black-000000.svg Documentation Status

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 blackdoc

Usage

The commandline interface supports two modes: checking and inplace reformatting.

python -m blackdoc --help

In 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 --help

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for keewis from gravatar.com keewis

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Justus Magin
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

0.3.9

0.3.8

0.3.7

0.3.6 yanked

Reason this release was yanked:

still a serious bug with triple-quoted strings

0.3.5 yanked

Reason this release was yanked:

serious bug with triple-quoted strings

0.3.4

0.3.3

This version

0.3.2

0.3.1

0.3

0.2

0.1.2

0.1.1

0.1.0

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.3.2.tar.gz (31.4 kB view details)

Uploaded Source

Built Distribution

blackdoc-0.3.2-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file blackdoc-0.3.2.tar.gz.

File metadata

  • Download URL: blackdoc-0.3.2.tar.gz
  • Upload date:
  • Size: 31.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.7

File hashes

Hashes for blackdoc-0.3.2.tar.gz
Algorithm Hash digest
SHA256 5a3644a82f942aab83c801075ee4f1ff31267e4e23237a25ec7af8fbe1b77c7a
MD5 f98cc9740c71f5ab33e2333e4a3f4503
BLAKE2b-256 89e46372d60c47b32825c2837369fb20586a284b3d1dd2149aab29ec113b313f

See more details on using hashes here.

File details

Details for the file blackdoc-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: blackdoc-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.7

File hashes

Hashes for blackdoc-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e094708c1c50e0ee81174de4bf62412b921656324663e74d648c5840a04dbb8
MD5 e25a600a96aadb675457879b56f76d63
BLAKE2b-256 b72e537597f343e2e0839c4b78270bfc3dd95189c4fcaf29332f22a4425c605c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page