69 consolidate pre commit dependencies with poetry (#71)

* Move flake8, codespell configs to pyproject.toml

* Switch pre-commit to local repository

* Fix pre-commit

Author: piotr-rarus

.flake8

@@ -26,38 +26,42 @@ repos:
       - id: absolufy-imports
         files: ^src/
 
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.4
+  - repo: local
     hooks:
       - id: codespell
+        name: codespell
+        entry: codespell
+        language: system
         types_or: [python, rst, markdown]
-        args: [--ignore-words=.codespell]
+        files: ^src/
 
-  - repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-    hooks:
       - id: isort
-        name: isort (python)
+        name: isort
+        entry: isort
+        language: system
+        files: ^src/
 
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
-    hooks:
       - id: pyupgrade
+        name: pyupgrade
+        entry: pyupgrade
+        language: system
         args: [--py310-plus]
+        files: ^src/
 
-  - repo: https://github.com/asottile/yesqa
-    rev: v1.4.0
-    hooks:
       - id: yesqa
+        name: yesqa
+        entry: yesqa
+        language: system
+        files: ^src/
 
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
-    hooks:
       - id: black
-        language_version: python3.10
+        name: black
+        entry: black
+        language: system
+        files: ^src/
 
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
-    hooks:
       - id: flake8
-        additional_dependencies: [flake8-isort]
+        name: flake8
+        entry: flake8
+        language: system
+        files: ^src/

.github/hooks/.pre-commit-config.yml

@@ -14,13 +14,11 @@ This is a template repository dedicated to ML projects in python. It provides so
 
 - `.github` - CI/CD pipelines, usually named after repository host (`.github`, `.azure`, `.gitlab`, etc)
 - `data` - if you need any data to be present locally, store it here
-- `notebooks` - notebooks are particularly _meh_, but this is the directory to put them
+- `notebooks` - notebooks are kinda _meh_, but this is the directory to put them
 - `src` - here goes your project's code
 - `src/cli` - project's entry points should be wrapped with CLI and exposed via Makefile, good idea to store them separately
 - `.codespell` - whitelist for project-related terms
 - `.coveragearc` - corage config, usually you don't want to report coverage on CLI, tests and some expressions
-- `.flake8` - `flake8` config
-- `isort.cfg` - `isort` config
 - `Makefile` - tasks definitions, much simpler to call `make` than writing whole commands in the terminal
 - `mypy.ini` - `mypy` config, usually some of your dependencies won't be hinted so you gonna ignore them here
 - `poetry.lock` - compiled dependencies

README.md

@@ -14,23 +14,32 @@ seaborn = "^0.11.2"
 
 [tool.poetry.group.dev.dependencies]
 black = "^23.3.0"
+codespell = "^2.2.4"
 coverage = "^7.2.2"
 flake8 = "^6.0.0"
+flake8-isort = "^6.0.0"
 isort = "^5.11.4"
 mypy = "^1.1.1"
 pre-commit = "^3.2.1"
 pytest = "^7.1.2"
 pytest-cov = "^3.0.0"
+pyupgrade = "^3.4.0"
 vulture = "^2.7"
+yesqa = "^1.4.0"
+
+[tool.flake8]
+max-line-length = 88
+include = "src"
 
 [tool.isort]
-profile = "black"
-multi_line_output = 3
-include_trailing_comma = "False"
+ensure_newline_before_comments = true
 force_grid_wrap = 0
-use_parentheses = "True"
-ensure_newline_before_comments = "True"
+include_trailing_comma = true
 line_length = 88
+multi_line_output = 3
+profile = "black"
+py_version = '310'
+use_parentheses = true
 
 [tool.black]
 line-length = 88
@@ -64,9 +73,12 @@ paths = ["src"]
 sort_by_size = true
 verbose = false
 
+[tool.codespell]
+ignore-words = ".codespell"
+
 [tool.pytest.ini_options]
-minversion = "7.0"
 addopts = "-ra --log-level=CRITICAL"
+minversion = "7.0"
 filterwarnings = [
     "ignore::UserWarning",
     "ignore::DeprecationWarning",