From e31104d0384b7c3232035243eda3ab2f9b1cc8cd Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 10 Feb 2022 14:05:26 +0100 Subject: [PATCH 1/3] Add pre-commit hook to run black, flake8 & isort --- .pre-commit-config.yaml | 13 +++++++++++++ pyproject.toml | 6 ++++++ tox.ini | 10 ++++++++++ 3 files changed, 29 insertions(+) create mode 100644 .pre-commit-config.yaml create mode 100644 pyproject.toml create mode 100644 tox.ini diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..13fbf401 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,13 @@ +repos: + - repo: https://github.com/psf/black + rev: 22.1.0 + hooks: + - id: black + - repo: https://github.com/PyCQA/isort + rev: 5.9.3 + hooks: + - id: isort + - repo: https://github.com/PyCQA/flake8 + rev: 4.0.1 + hooks: + - id: flake8 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..442cc5af --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[tool.black] +skip-string-normalization = true +target-version = ['py38'] + +[tool.isort] +multi_line_output = 4 diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..d9fa1946 --- /dev/null +++ b/tox.ini @@ -0,0 +1,10 @@ +[flake8] +count = True +exclude = + migrations + resources # exclude code that will be deprecated + tests # exclude code that will be deprecated +max-complexity = 10 +max-line-length = 120 +show-source = True +statistics = True From e2d412c7d0e7cde809e88811163944a6129b2398 Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 10 Feb 2022 20:30:40 +0100 Subject: [PATCH 2/3] Add CONTRIBUTING.nd & requirements-dev.txt --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ requirements-dev.txt | 4 ++++ 2 files changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 requirements-dev.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..16e3dfea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +; SHARED on https://pad.cas.cat/usody-devicehub-contributing + +# Contributing to devicehub + +## Writing code + +### Coding style + +#### Python style +- Unless otherwise specified, follow [PEP 8](https://www.python.org/dev/peps/pep-0008). Use [flake8](https://pypi.org/project/flake8/) to check for problems in this area. +- Use [isort](https://github.com/PyCQA/isort#readme) to automate import sorting. + +To automatize this work just configure `pre-commit` hooks in your development environment: +```bash +# on your virtual environment +pip install -r requirements-dev.txt +pre-commit install +``` + +#### HTML (templates) +- Template file names should be all lowercase, using underscores instead of camelCase. + + Do this: `device_detail.html` + + Don't do this: `DeviceDetail.html`, `Device-detail.html` diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 00000000..02778f7d --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,4 @@ +black +isort +flake8 +pre-commit From 36da72ac6bac6dac6e210c6a8b68d5f16bb9f73a Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Fri, 11 Feb 2022 11:30:57 +0100 Subject: [PATCH 3/3] Add check pdb as pre-commit hook Avoid commits with pdb.set_trace() statements --- .pre-commit-config.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 13fbf401..63a0458c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,3 +11,7 @@ repos: rev: 4.0.1 hooks: - id: flake8 + - repo: https://github.com/conorfalvey/check_pdb_hook + rev: 0.0.9 + hooks: + - id: check_pdb_hook