build: add pre-commit files (#105)

add pre-commit-config.yaml and pre-commit as a dependency
vasp-dev · Aug 3, 2023 · b4f74e3 · b4f74e3
1 parent a55805b
commit b4f74e3
Show file tree

Hide file tree

Showing 4 changed files with 185 additions and 2 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/ambv/black
+    rev: 22.6.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
diff --git a/README.md b/README.md
@@ -67,7 +67,11 @@ black src tests
 isort src tests
 ~~~
 before committing the code. This will autoformat your code and sort the import
-statements in a consistent order.
+statements in a consistent order. If you would like this code formatting to be done
+along with each commit, you can run
+~~~shell
+pre-commit install
+~~~
 
 ## Contributing to py4vasp
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,6 +39,7 @@ hypothesis = ">=6.48.1"
 black = ">=22.6.0"
 isort = ">=5.10.1"
 ipykernel = ">=6.25.0"
+pre-commit = ">=3.3.3"
 
 [tool.poetry.group.doc.dependencies]
 sphinx = ">=5.0.2"