Merge pull request #16 from AKKI0511/codex/create-ci-workflow-with-caching-and-checks

Add CI workflow

Author: AKKI0511

.flake8

@@ -1,3 +1,3 @@
 [flake8]
 max-line-length = 88
-extend-ignore = E203, W503
+extend-ignore = E203, W503, F401, F841, E402

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: |
+            requirements.txt
+            setup.py
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -e .
+
+      - name: Lint with flake8
+        run: flake8
+
+      - name: Check formatting with black
+        run: black --check .
+
+      - name: Run tests
+        run: pytest

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.3.0
+    hooks:
+      - id: black
+        language_version: python3.11
+        args: ["--check"]
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        language_version: python3.11
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: pytest
+        language: system
+        types: [python]
+        pass_filenames: false

README.md

@@ -100,6 +100,17 @@ pip install -r requirements.txt
 python setup.py develop
 ```
 
+## Development
+
+Install pre-commit hooks to run the same checks as the CI pipeline:
+
+```bash
+pre-commit install
+pre-commit run --all-files
+```
+
+The hooks will run `black --check`, `flake8`, and `pytest` before every commit.
+
 ## Data Caching
 
 The `DataLoader` caches downloaded OHLCV data in parquet format to reduce

requirements.txt

@@ -12,6 +12,7 @@ python-dotenv
 pytest
 black
 flake8
+pre-commit
 PyYAML
 tqdm
 optuna