Skip to content

Commit

Permalink
Remove old comment about pre-release black
Browse files Browse the repository at this point in the history
  • Loading branch information
peterjc authored Aug 30, 2023
1 parent 6f7fe8e commit 3808e1f
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,26 +94,13 @@ You can request only the ``BLK`` codes be shown using::
Python package management
-------------------------

We covered using pip or conda by hand above. If you are using a PyPI based
Python dependency system like pipenv or poetry, you may run into complications
because at the time of writing all the black releases to PyPI have been tagged
as pre-releases (beta code). `PEP440 Handling of pre-releases
<https://www.python.org/dev/peps/pep-0440/#handling-of-pre-releases>`_
could be more explicit here.

For pipenv, flake8-black v0.2.0 onwards should just work.

For poetry, include this in your ``pyproject.toml`` configuration file::

[tool.poetry.dev-dependencies]
...
black = { version = "*", allow-prereleases = true }
...

In either case, for large projects you should consider pinning the exact
For large projects especially, you should consider pinning the exact
version of black you want to use as their updates do sometimes introduce
changes which would show up as new ``BLK100`` violations via flake8.

You should be able to specify your black version in your conda or pip
requirements or environment, or using using pipenv or poetry etc.

Configuration
-------------

Expand Down

0 comments on commit 3808e1f

Please sign in to comment.