Use black in ci.

Author: j-bennet

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Black all the code.
+33e8b461b6ddb717859dde664b71209ce69c119a

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,3 +7,5 @@
 <!--- We appreciate your help and want to give you credit. Please take a moment to put an `x` in the boxes below as you complete them. -->
 - [ ] I've added this contribution to the `CHANGELOG`.
 - [ ] I've added my name to the `AUTHORS` file (or it's already there).
+- [ ] I installed pre-commit hooks (`pip install pre-commit && pre-commit install`), and ran `black` on my code.
+- [x] Please squash merge this pull request (uncheck if you'd like us to merge as multiple commits)

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3.7

.travis.yml

@@ -5,7 +5,7 @@ install: ./.travis/install.sh
 script:
   - source ~/.venv/bin/activate
   - tox
-
+  - if [[ "$TOXENV" == "py37" ]]; then black --check cli_helpers tests ; else echo "Skipping black for $TOXENV"; fi
 matrix:
   include:
     - os: linux

.travis/install.sh

@@ -22,4 +22,4 @@ fi
 pip install virtualenv
 python -m virtualenv ~/.venv
 source ~/.venv/bin/activate
-pip install tox
+pip install -r requirements-dev.txt -U --upgrade-strategy only-if-needed

CONTRIBUTING.rst

@@ -80,18 +80,24 @@ You can also measure CLI Helper's test coverage by running::
 Coding Style
 ------------
 
-CLI Helpers requires code submissions to adhere to
-`PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_.
-It's easy to check the style of your code, just run::
+When you submit a PR, the changeset is checked for pep8 compliance using
+`black <https://github.com/psf/black>`_. If you see a build failing because
+of these checks, install ``black`` and apply style fixes:
 
-    $ pep8radius master
+::
 
-If you see any PEP 8 style issues, you can automatically fix them by running::
+    $ pip install black
+    $ black .
 
-    $ pep8radius master --in-place
+Then commit and push the fixes.
 
-Be sure to commit and push any PEP 8 fixes.
+To enforce ``black`` applied on every commit, we also suggest installing ``pre-commit`` and
+using the ``pre-commit`` hooks available in this repo:
 
+::
+
+    $ pip install pre-commit
+    $ pre-commit install
 
 Documentation
 -------------

MANIFEST.in

@@ -6,3 +6,4 @@ recursive-include docs *.rst
 recursive-include docs Makefile
 recursive-include tests *.py
 include tests/config_data/*
+exclude .pre-commit-config.yaml .git-blame-ignore-revs

requirements-dev.txt

@@ -1,7 +1,7 @@
 autopep8==1.3.3
 codecov==2.0.9
 coverage==4.3.4
-pep8radius
+black>=20.8b1
 Pygments>=2.4.0
 pytest==3.0.7
 pytest-cov==2.4.0

tasks.py

@@ -71,7 +71,7 @@ def initialize_options(self):
 
     def run(self):
         """Run the linter."""
-        cmd = "pep8radius {branch} {{fix: --in-place}}{{verbose: -vv}}"
+        cmd = "black ."
         cmd = cmd.format(branch=self.branch)
         self.call_and_exit(self.apply_options(cmd, ("fix",)))
 

tox.ini

@@ -12,7 +12,6 @@ setenv =
 commands =
     pytest --cov-report= --cov=cli_helpers
     coverage report
-    pep8radius master
     bash -c 'if [ -n "$CODECOV" ]; then {envbindir}/coverage xml && {envbindir}/codecov; fi'
 deps = -r{toxinidir}/requirements-dev.txt
 usedevelop = True