Skip to main content

docstrfmt: A formatter for Sphinx flavored reStructuredText.

Project description

Latest docstrfmt Version Supported Python Versions PyPI - Downloads - Monthly Coveralls Coverage Github Actions Coverage Contributor Covenant

Strongly inspired by rstfmt and rustfmt.

This is considered to be in beta however it is mostly stable.

Description

docstrfmt is a tool for automatically formatting reStructuredText in files and Python docstrings in a consistent way.

Like Black and rstfmt, the motivation is to provide a format that is reasonable and minimally configurable to prevent teams from wasting time on style discussions (or individuals on manually doing formatting, for that matter).

Currently, docstrfmt is in an early stage of development. The most common reST constructs are covered but there are some that are not. If there is a construct missing and would like to add it, feel free to open a PR to add it or open an issue and I’ll see what I can do.

To get a feel for the output of docstrfmt, see the sample file.

Differences between docstrfmt and rstfmt

The main difference between rstfmt and docstrfmt is the ability to format Python docstrings. I am open to merging this project with rstfmt, however, there as several differences in formatting conventions between the two (hence the separate fork).

Usage

# Install.
pip install docstrfmt

# Install the development version.
pip install https://github.com/LilSpazJoekp/docstrfmt/archive/master.zip

# Read a file from stdin and write the formatted version to stdout.
docstrfmt

# Format the given file(s) in place.
docstrfmt <file>...

# Format the given files, printing all output to stdout.
docstrfmt -o <file>...

# Wrap paragraphs to the given line length where possible (default to whatever is
# set for black).

docstrfmt -l <length>

Like Black’s blackd, there is also a daemon that provides formatting via HTTP requests to avoid the cost of starting and importing everything on every run.

# Install.
pip install "docstrfmt[d]"

# Install the development version.
pip install "https://github.com/LilSpazJoekp/docstrfmt/archive/master.zip#egg=docstrfmt[d]"

# Start the daemon (binds to localhost:5219 by default).
docstrfmtd --bind-host=<host> --bind-port=<port>

# Print the formatted version of a file.
curl http://locahost:5219 --data-binary @<file>

# Specify the line length (default to whatever is set for black).
curl -H 'X-Line-Length: 72' http://locahost:5219 --data-binary @<file>

# Mimic the standalone tool: read from stdin, write to stdout, exit with
# a nonzero status code if there are errors.
curl -fsS http://locahost:5219 --data-binary @/dev/stdin

With Editors

PyCharm

Instructions derived from black documentation

  1. Install.

    pip install "docstrfmt[d]"
  2. Locate where docstrfmt is installed.

    • On macOS / Linux / BSD:

      which docstrfmt
      # /usr/local/bin/docstrfmt  # possible location
    • On Windows:

      where docstrfmt
      # C:\Program Files\Python39\Scripts\docstrfmt.exe
  1. Open External tools in PyCharm.

    • On macOS:

      PyCharm -> Preferences -> Tools -> External Tools

    • On Windows / Linux / BSD:

      File -> Settings -> Tools -> External Tools

  2. Click the + icon to add a new external tool with the following values:

    • Name: docstrfmt

    • Description:

    • Program: <install_location_from_step_2>

    • Arguments: "$FilePath$"

  3. Format the currently opened file by selecting Tools -> External Tools -> docstrfmt.

    • Alternatively, you can set a keyboard shortcut by navigating to Preferences or Settings -> Keymap -> External Tools -> External Tools - docstrfmt.

  4. Optionally, run docstrfmt on every file save:

    1. Make sure you have the File Watchers plugin installed.

    2. Go to Preferences or Settings -> Tools -> File Watchers and click + to add a new watcher:

      • Name: docstrfmt

      • File type: Python

      • Scope: Project Files

      • Program: <install_location_from_step_2>

      • Arguments: $FilePath$

      • Output paths to refresh: $FilePath$

      • Working directory: $ProjectFileDir$

    3. Uncheck “Auto-save edited files to trigger the watcher” in Advanced Options

With pre-commit

repos:
  - repo: https://github.com/LilSpazJoekp/docstrfmt
    rev: stable # Replace by any tag/version: https://github.com/LilSpazJoekp/docstrfmt/tags
    hooks:
      - id: docstrfmt
        language_version: python3
        types_or: [python, rst, txt] # only needed if you want to include txt files.

Project details


Download files

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

Source Distribution

docstrfmt-1.10.0.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

docstrfmt-1.10.0-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file docstrfmt-1.10.0.tar.gz.

File metadata

  • Download URL: docstrfmt-1.10.0.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for docstrfmt-1.10.0.tar.gz
Algorithm Hash digest
SHA256 9da96e71552937f4b49ae2d6ab1c118ffa8ad6968082e6b8fd978b01d1bc0066
MD5 edbc14455f94a7e3f5d5a047c03cae7f
BLAKE2b-256 ec9789bde47c76d0a5bf3e0062e88e5ae4c9f0e3f3575731a0f74d160965c772

See more details on using hashes here.

Provenance

The following attestation bundles were made for docstrfmt-1.10.0.tar.gz:

Publisher: pypi.yml on LilSpazJoekp/docstrfmt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file docstrfmt-1.10.0-py3-none-any.whl.

File metadata

  • Download URL: docstrfmt-1.10.0-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for docstrfmt-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a34ef6f3d8ab3233a7d0b3d1c2f3c66f8acbb3917df5ed2f3e34c1629ac29cef
MD5 90a858662368ddeeef2194e3938013f5
BLAKE2b-256 0cb44bd7265a419eb36a31ae09f504100a4b26cb651f7a2c0eae58d90143086d

See more details on using hashes here.

Provenance

The following attestation bundles were made for docstrfmt-1.10.0-py3-none-any.whl:

Publisher: pypi.yml on LilSpazJoekp/docstrfmt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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