docformatter
Formats docstrings to follow PEP 257 (by PyCQA)
black
The uncompromising Python code formatter [Moved to: https://github.com/psf/black] (by python)
Our great sponsors
| docformatter | black | |
|---|---|---|
| 1 | 3 | |
| 504 | 21,526 | |
| 3.0% | - | |
| 6.9 | 9.3 | |
| 2 months ago | almost 3 years ago | |
| Python | Python | |
| MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
docformatter
Posts with mentions or reviews of docformatter.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-03-31.
-
[Python] No docstring formatters?
I can't find any decent automatic docstring formatter. The only two I stumble upon so far are docformatter and pyment, but none of them wraps long lines. I heard PyCharm has a formatter, but I would rather stick with VSCode.
black
Posts with mentions or reviews of black.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-11-12.
-
A Tale of Two Kitchens - Hypermodernizing Your Python Code Base
To get all your code into a consistent format the next step is to run a formatter. I recommend black, the well-known uncompromising code formatter, which is the most popular choice. Alternatives to black are autoflake, prettier and yapf, if you do not agree with blacks constraints.
- GitHub - Netflix-Skunkworks/policyuniverse: Parse and Process AWS IAM Policies, Statements, ARNs, and wildcards.
-
Make your Django project newbie contributor friendly with pre-commit
$ pre-commit install pre-commit installed at .git/hooks/pre-commit $ git add .pre-commit-config.yaml $ git commit -m "Add pre-commit config" [INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Initializing environment for https://gitlab.com/pycqa/flake8. [INFO] Initializing environment for https://github.com/pycqa/isort. [INFO] Initializing environment for https://github.com/python/black. [INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://gitlab.com/pycqa/flake8. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/pycqa/isort. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/python/black. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... Trim Trailing Whitespace.................................................Passed Check Yaml...............................................................Passed Check for merge conflicts................................................Passed Debug Statements (Python)............................(no files to check)Skipped Check for added large files..............................................Passed Fix requirements.txt.................................(no files to check)Skipped Check django project for potential problems..........(no files to check)Skipped Check django project for missing migrations..........(no files to check)Skipped flake8...............................................(no files to check)Skipped isort................................................(no files to check)Skipped black................................................(no files to check)Skipped
What are some alternatives?
When comparing docformatter and black you can also consider the following projects:
pyment - Format and convert Python docstrings and generates patches
Flake8 - flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.
py-doq - Docstring generator
autopep8 - A tool that automatically formats Python code to conform to the PEP 8 style guide.
numdoclint - Numdoc Lint provides features such as NumPy style docstring code checking.
flake8
black - The uncompromising Python code formatter
blue - The slightly less uncompromising Python code formatter.
glacier - :snowflake: Building Python CLI using docstrings and typehints :snake:
isort - A Python utility / library to sort imports.
pre-commit-hooks - Some out-of-the-box hooks for pre-commit
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.