misc: add black files/notes

This commit is contained in:
Frédéric Péters 2021-02-04 10:40:55 +01:00
parent 4ebe82ef21
commit 69bd6d3d2c
3 changed files with 22 additions and 0 deletions

2
.git-blame-ignore-revs Normal file
View File

@ -0,0 +1,2 @@
# trivial: apply black
4ebe82ef21fed8353ac38f8257c69a1a31322634

8
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,8 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/psf/black
rev: 20.8b1
hooks:
- id: black
args: ['--target-version', 'py37', '--skip-string-normalization', '--line-length', '110']

12
README
View File

@ -31,6 +31,18 @@ Then you need to run the tests
It is possible to pass a --without-postgresql-tests parameter to skip the
PostgreSQL tests.
Code Style
----------
black is used to format the code, using thoses parameters:
black --target-version py37 --skip-string-normalization --line-length 110
There is .pre-commit-config.yaml to use pre-commit to automatically run black
before commits. (execute `pre-commit install` to install the git hook.)
Copyright
---------