chore: set up flake8, isort and black with pre-commit

TinyTapeout · Sep 21, 2023 · 5725713 · 5725713
1 parent 3f8a476
commit 5725713
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 2 deletions.
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,2 @@
+[flake8]
+extend-ignore = E203,E501,F541
diff --git a/.isort.cfg b/.isort.cfg
@@ -0,0 +1,2 @@
+[settings]
+profile = black
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,15 @@
+repos:
+ - repo: https://github.com/PyCQA/flake8
+ rev: 6.0.0
+ hooks:
+ - id: flake8
+
+ - repo: https://github.com/PyCQA/isort
+ rev: 5.12.0
+ hooks:
+ - id: isort
+
+ - repo: https://github.com/ambv/black
+ rev: 23.3.0
+ hooks:
+ - id: black
diff --git a/README.md b/README.md
@@ -1,6 +1,13 @@
 # Tiny Tapeout tools
 
-Tools used mostly by the Tiny Tapeout github actions
+Tools used mostly by the Tiny Tapeout GitHub Actions
+
+## Setup
+
+```
+pip install -r requirements.txt
+pre-commit install
+```
 
 ## Documentation
 

diff --git a/lint.sh b/lint.sh
diff --git a/requirements.txt b/requirements.txt
@@ -29,3 +29,4 @@ webencodings==0.5.1
 yowasp-runtime==1.22
 yowasp-yosys==0.30.0.0.post538
 zipp==3.15.0
+pre-commit==3.4.0