The uncompromising code formatter
=================================
+ “Any color you like.”
+
By using *Black*, you agree to cede control over minutiae of
hand-formatting. In return, *Black* gives you speed, determinism, and
freedom from `pycodestyle` nagging about formatting. You will save time
Try it out now using the `Black Playground <https://black.vercel.app>`_.
-.. admonition:: Note - this is a beta product
+.. admonition:: Note - Black is now stable!
- *Black* is already `successfully used <https://github.com/psf/black#used-by>`_ by
+ *Black* is `successfully used <https://github.com/psf/black#used-by>`_ by
many projects, small and big. *Black* has a comprehensive test suite, with efficient
- parallel tests, our own auto formatting and parallel Continuous Integration runner.
- However, *Black* is still beta. Things will probably be wonky for a while. This is
- made explicit by the "Beta" trove classifier, as well as by the "b" in the version
- number. What this means for you is that **until the formatter becomes stable, you
- should expect some formatting to change in the future**. That being said, no drastic
- stylistic changes are planned, mostly responses to bug reports.
+ parallel tests, our own auto formatting and parallel Continuous Integration runner.
+ Now that we have become stable, you should not expect large formatting to changes in
+ the future. Stylistic changes will mostly be responses to bug reports and support for new Python
+ syntax.
Also, as a safety measure which slows down processing, *Black* will check that the
reformatted code still produces a valid AST that is effectively equivalent to the
Testimonials
------------
+**Mike Bayer**, author of `SQLAlchemy <https://www.sqlalchemy.org/>`_:
+
+ *I can't think of any single tool in my entire programming career that has given me a
+ bigger productivity increase by its introduction. I can now do refactorings in about
+ 1% of the keystrokes that it would have taken me previously when we had no way for
+ code to format itself.*
+
**Dusty Phillips**, `writer <https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips>`_:
*Black is opinionated so you don't have to be.*
.. toctree::
:maxdepth: 3
:includehidden:
+ :caption: User Guide
getting_started
usage_and_configuration/index
integrations/index
guides/index
+ faq
.. toctree::
- :maxdepth: 3
+ :maxdepth: 2
:includehidden:
+ :caption: Development
contributing/index
change_log
.. toctree::
:hidden:
+ :caption: Project Links
- GitHub ↪ <https://github.com/psf/black>
- PyPI ↪ <https://pypi.org/project/black>
- IRC ↪ <https://webchat.freenode.net/?channels=%23blackformatter>
+ GitHub <https://github.com/psf/black>
+ PyPI <https://pypi.org/project/black>
+ Chat <https://discord.gg/RtVdv86PrH>
Indices and tables
==================