Dev

.dockerignore

@@ -0,0 +1,106 @@
+# ========================
+# Documentation and config files
+# ========================
+.gitignore
+LICENSE.md
+README.md
+
+# ========================
+# Directories not needed in the image
+# ========================
+utils/
+notebooks/
+data/
+
+# ========================
+# Python bytecode and caches
+# ========================
+__pycache__/
+*.pyс
+*.pyo
+*.pyd
+*.so
+
+# ========================
+# Virtual environments
+# ========================
+.venv/
+venv/
+env/
+
+# ========================
+# Build artifacts and packages
+# ========================
+build/
+dist/
+*.egg-info/
+*.whl
+
+# ========================
+# IDEs and editors
+# ========================
+.idea/
+.vscode/
+*.sublime-project
+*.sublime-workspace
+
+# ========================
+# Logs and temporary files
+# ========================
+*.log
+tmp/
+tmp.*
+
+# ========================
+# Jupyter notebooks and artifacts
+# ========================
+.ipynb_checkpoints/
+test.ipynb
+*.nbconvert.ipynb
+
+# ========================
+# Testing and coverage
+# ========================
+.coverage
+coverage.xml
+.cache/
+.hypothesis/
+
+# ========================
+# Type checkers and linters
+# ========================
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+
+# ========================
+# Training / ML outputs
+# ========================
+checkpoints/
+output/
+model/
+runs/
+
+# ========================
+# nbQA cache
+# ========================
+__nbqa_cache__/
+
+# ========================
+# Exceptions (keep files)
+# ========================
+!data/raw/*.json
+!example*.*
+
+# ========================
+# System files
+# ========================
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# ========================
+# Docker-related files
+# ========================
+docker-compose.override.yml
+docker-compose.local.yml

.github/workflows/python-app.yml

@@ -0,0 +1,32 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ "dev" ]
+  pull_request:
+    branches: [ "dev" ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff black
+
+      - name: Run Black
+        run: |
+          black --check .
+
+      - name: Run Ruff
+        run: |
+          ruff check .

.gitignore

@@ -1,139 +1,108 @@
-# Byte-compiled / optimized / DLL files
+# ========================
+# Python bytecode/cache
+# ========================
 __pycache__/
 *.py[cod]
-*$py.class
-
-# C extensions
+*.pyo
+*.pyd
 *.so
 
-# Distribution / packaging
-.Python
+# ========================
+# Poetry & Virtual Envs
+# ========================
+.env
+.venv/
+venv/
+env/
+
+# ========================
+# Build artifacts
+# ========================
 build/
-develop-eggs/
 dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
 *.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
+*.whl
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
+# ========================
+# IDEs / Editors
+# ========================
+.idea/
+.vscode/
+*.sublime-project
+*.sublime-workspace
 
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
+# ========================
+# Logs & Temporary Files
+# ========================
+*.log
+tmp/
+tmp.*
+cache/
+cache_data.duckdb
+cache_data.duckdb.*
+
+# ========================
+# Jupyter Notebooks
+# ========================
+.ipynb_checkpoints/
+test.ipynb
+*.nbconvert.ipynb
+
+# ========================
+# Coverage / Testing
+# ========================
 .coverage
-.coverage.*
-.cache
-nosetests.xml
 coverage.xml
-*.cover
-*.py,cover
+.cache/
 .hypothesis/
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
 
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
+# ========================
+# Type checker / linters
+# ========================
 .mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# Pycharm
-.idea/
+.ruff_cache/
+.pytest_cache/
 
-# Db files
+# ========================
+# Security & Secrets
+# ========================
+*.env
+*.env.*
+*.secret
+*.token
+*.key
+*.pem
 *.db
 db/
 
-# Mac files
+# ========================
+# Training / ML outputs
+# ========================
+checkpoints/
+output/
+model/
+runs/                # e.g. for TensorBoard or wandb
+
+# ========================
+# nbQA artifacts
+# ========================
+__nbqa_cache__/
+
+# ========================
+# Custom ignore rules
+# ========================
+Todo.md
+
+# ========================
+# Exceptions (keep files)
+# ========================
+!data/raw/*.json
+!example*.*
+!.env.example
+
+# ========================
+# System files
+# ========================
 .DS_Store
+Thumbs.db
+desktop.ini