Precommit hook for black (#103)

* add precommit hook

* fmt

* fix: ci

Author: Thykof

.github/workflows/ci.yaml

@@ -25,6 +25,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
+          pip install -r requirements-dev.txt
 
       - name: Run Pylint
         run: |

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+    - id: black
+      language_version: python3.10

README.md

@@ -47,6 +47,7 @@
   - [2.2. Setup](#22-setup)
   - [2.3. Miners](#23-miners)
   - [2.4. Validators](#24-validators)
+  - [2.5. Develop](#25-develop)
 * [3. License](#-3-license)
 
 ## 🔭 1. Overview
@@ -350,6 +351,15 @@ Please refer to this [guide](./docs/validator_guide.md) for detailed instruction
 
 <sup>[Back to top ^][table-of-contents]</sup>
 
+### 2.5 Develop
+
+```shell
+pip install -r requirements-dev.txt
+pre-commit install
+```
+
+<sup>[Back to top ^][table-of-contents]</sup>
+
 ## 📄 3. License
 
 Please refer to the [LICENSE](./LICENSE) file.

alembic/env.py

@@ -20,13 +20,13 @@
     fileConfig(config.config_file_name)
 
 # Get the individual environment variables
-if os.getenv('DB_URL_TEST') is not None:
-    db_url = os.getenv('DB_URL_TEST')
+if os.getenv("DB_URL_TEST") is not None:
+    db_url = os.getenv("DB_URL_TEST")
 else:
     db_url = f"postgresql://{os.getenv('POSTGRES_USER')}:{os.getenv('POSTGRES_PASSWORD')}@{os.getenv('POSTGRES_HOST')}:{os.getenv('POSTGRES_PORT')}/{os.getenv('POSTGRES_DB')}"
 
 # Get database URL from environment variable
-config.set_main_option('sqlalchemy.url', db_url)
+config.set_main_option("sqlalchemy.url", db_url)
 
 # add your model's MetaData object here
 # for 'autogenerate' support

pyproject.toml

@@ -0,0 +1,19 @@
+[tool.black]
+line-length = 79
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | env
+  | venv
+  | bt_venv
+  | .eggs
+)/
+'''

requirements-dev.txt

@@ -0,0 +1,5 @@
+pre_commit==4.1.0
+pytest>=8
+black>=25.1.0
+testcontainers>=4.9.0
+pylint>=3.3.4

requirements.txt

@@ -1,7 +1,6 @@
 starlette>=0.37.2
 pydantic>=2
 rich>=13
-pytest>=8
 numpy>=1
 setuptools>=68
 requests>=2
@@ -12,7 +11,4 @@ alembic>=1.14.0
 python-dotenv>=1.0.1
 psycopg2-binary>=2.9.10
 sqlalchemy>=2.0.36
-testcontainers>=4.9.0
 wandb>=0.19.4
-pylint>=3.3.4
-black>=25.1.0