From 608cc8e61bfe1c0a62bc2ae5d05ef12f98239ee2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20P=C3=A9ters?= Date: Sun, 17 Jan 2021 10:37:15 +0100 Subject: [PATCH] misc: add black files/notes --- .git-blame-ignore-revs | 3 +++ .pre-commit-config.yaml | 8 ++++++++ README | 11 +++++++++++ 3 files changed, 22 insertions(+) create mode 100644 .git-blame-ignore-revs create mode 100644 .pre-commit-config.yaml diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000..10e448e --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,3 @@ +# black +0856ac758fb7bc97ec089ca8bd1395379028fa66 +11fe0141d6981f048bceb8977af8a9eb5bbfe430 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..a14705c --- /dev/null +++ b/.pre-commit-config.yaml @@ -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'] diff --git a/README b/README index ec6a65a..3c9f92c 100644 --- a/README +++ b/README @@ -28,6 +28,17 @@ local_settings.py file set in the same directory, or by a file referenced in the SCRUTINY_SETTINGS_FILE environment variable. +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.) + + License -------