Feat/automate unified doc creation

.env.example

@@ -0,0 +1,6 @@
+# Database Schema Spec Generator Configuration
+
+# Base URL for generated schema files
+# This URL will be used in the generated schema files as the base for references
+# Example: https://api.example.com/schemas
+BASE_URL=https://example.com

.github/actions/setup/action.yaml

@@ -0,0 +1,16 @@
+name: Setup UV and python
+runs:
+  using: "composite"
+  steps:
+    # Setup Python
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: ".python-version" # Use .python-version file to set Python version
+
+    # Setup uv
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: "0.8.0" # Specify the version of uv to use
+        enable-cache: true # Enable caching for uv dependencies

.github/workflows/ci.yaml

@@ -0,0 +1,69 @@
+name: ci
+
+on:
+  pull_request:
+    branches:
+      - main # Run on every PR to main
+      - staging # Run on every PR to staging
+      - dev # Run on every PR to dev
+      - feature/* # Run on every PR to feature branches
+  workflow_call: # This makes it reusable in other workflows
+jobs:
+  install_dependencies:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout code
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      # "Installs project dependencies failing if `uv.lock` is missing or out of sync"
+      - name: Install project dependencies
+        run: uv sync --dev --locked --all-extras
+
+  linting:
+    runs-on: ubuntu-latest
+    needs: [install_dependencies]
+    steps:
+      # Checkout code
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      # Run linting check
+      - name: Run linting check
+        run: uv run ruff check .
+
+  formatting:
+    runs-on: ubuntu-latest
+    needs: [install_dependencies]
+    steps:
+      # Checkout code
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      # Run formatting check
+      - name: Run formatting check
+        run: uv run ruff format --check .
+
+  type_checking:
+    runs-on: ubuntu-latest
+    needs: [install_dependencies]
+    steps:
+      # Checkout code
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      # Run type checking
+      - name: Run type checking
+        run: uv run pyright .
+
+  tests:
+    runs-on: ubuntu-latest
+    needs: [install_dependencies]
+    steps:
+      # Checkout code
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      # Run tests
+      - name: Run tests
+        run: uv run pytest

.gitignore

@@ -0,0 +1,209 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+.venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Project or developer specific files
+AGENTS.md
+.kilocode/
+output/

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.8.0
+    hooks:
+      # Update the uv lockfile
+      - id: uv-lock
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.5
+    hooks:
+      # Run the linter with fixes (excluding import sorting)
+      - id: ruff
+        name: "ruff-lint"
+        args: [--fix, --exit-non-zero-on-fix]
+        # Ignores I rules to separate linting from import sorting
+
+      # Sort imports (matches `ruff check --select I --fix`)
+      # Selects only I (import sorting) rules and fixes them
+      - id: ruff
+        name: "ruff-sort-imports"
+        args: [--select, "I", --fix, --exit-non-zero-on-fix]
+
+      # Format (matches `ruff format`)
+      - id: ruff-format
+        name: "ruff-format"
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.403
+    hooks:
+      - id: pyright
+        name: "pyright"

.python-version

@@ -0,0 +1 @@
+3.13