All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
2 black documentation master file, created by
3 sphinx-quickstart on Fri Mar 23 10:53:30 2018.
6 # The uncompromising code formatter
8 > “Any color you like.”
10 By using _Black_, you agree to cede control over minutiae of hand-formatting. In return,
11 _Black_ gives you speed, determinism, and freedom from `pycodestyle` nagging about
12 formatting. You will save time and mental energy for more important matters.
14 _Black_ makes code review faster by producing the smallest diffs possible. Blackened
15 code looks the same regardless of the project you're reading. Formatting becomes
16 transparent after a while and you can focus on the content instead.
18 Try it out now using the [Black Playground](https://black.vercel.app).
20 ```{admonition} Note - Black is now stable!
21 *Black* is [successfully used](https://github.com/psf/black#used-by) by
22 many projects, small and big. *Black* has a comprehensive test suite, with efficient
23 parallel tests, our own auto formatting and parallel Continuous Integration runner.
24 Now that we have become stable, you should not expect large formatting to changes in
25 the future. Stylistic changes will mostly be responses to bug reports and support for new Python
28 Also, as a safety measure which slows down processing, *Black* will check that the
29 reformatted code still produces a valid AST that is effectively equivalent to the
31 [Pragmatism](./the_black_code_style/current_style.md#pragmatism)
32 section for details). If you're feeling confident, use `--fast`.
36 {doc}`Black is licensed under the MIT license <license>`.
41 **Mike Bayer**, author of [SQLAlchemy](https://www.sqlalchemy.org/):
43 > _I can't think of any single tool in my entire programming career that has given me a
44 > bigger productivity increase by its introduction. I can now do refactorings in about
45 > 1% of the keystrokes that it would have taken me previously when we had no way for
46 > code to format itself._
49 [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
51 > _Black is opinionated so you don't have to be._
53 **Hynek Schlawack**, creator of [attrs](https://www.attrs.org/), core developer of
56 > _An auto-formatter that doesn't suck is all I want for Xmas!_
58 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
60 > _At least the name is good._
62 **Kenneth Reitz**, creator of [requests](http://python-requests.org/) and
63 [pipenv](https://docs.pipenv.org/):
65 > _This vastly improves the formatting of our code. Thanks a ton!_
69 Use the badge in your project's README.md:
72 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
75 Using the badge in README.rst:
78 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
79 :target: https://github.com/psf/black
84 ```{image} https://img.shields.io/badge/code%20style-black-000000.svg
85 :target: https://github.com/psf/black
96 the_black_code_style/index
107 usage_and_configuration/index
128 caption: Project Links
131 GitHub <https://github.com/psf/black>
132 PyPI <https://pypi.org/project/black>
133 Chat <https://discord.gg/RtVdv86PrH>