edda-framework 0.1.0__tar.gz

edda_framework-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_USER: edda
+          POSTGRES_PASSWORD: edda_test_password
+          POSTGRES_DB: edda_test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+      mysql:
+        image: mysql:9
+        env:
+          MYSQL_ROOT_PASSWORD: root_password
+          MYSQL_DATABASE: edda_test
+          MYSQL_USER: edda
+          MYSQL_PASSWORD: edda_test_password
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+        ports:
+          - 3306:3306
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies (all database drivers)
+        run: uv sync --extra dev --extra postgresql --extra mysql
+
+      - name: Run tests (all databases)
+        env:
+          EDDA_TEST_POSTGRES_URL: postgresql+asyncpg://edda:edda_test_password@localhost:5432/edda_test
+          EDDA_TEST_MYSQL_URL: mysql+aiomysql://edda:edda_test_password@localhost:3306/edda_test
+        run: uv run pytest -v --tb=short
+
+      - name: Type check
+        run: uv run mypy edda
+
+      - name: Lint with ruff
+        run: uv run ruff check edda tests
+
+      - name: Check formatting
+        run: uv run black --check edda tests

edda_framework-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    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 Zensical
+        run: pip install zensical
+
+      - name: Build documentation
+        run: zensical build --clean
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: 'site/'  # Zensical's default output directory
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

edda_framework-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  id-token: write # Required for PyPI Trusted Publishing (OIDC)
+  contents: write # Required for creating releases
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

edda_framework-0.1.0/.gitignore

@@ -0,0 +1,101 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual Environment
+.venv/
+venv/
+ENV/
+env/
+.env
+
+# Testing
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+coverage.xml
+*.cover
+.hypothesis/
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Database files
+*.db
+*.sqlite
+*.sqlite3
+
+# Ruff
+.ruff_cache/
+
+# Distribution / packaging
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Backup files
+*.bak
+*.backup
+
+# Log files (root directory)
+*.log
+
+# Debug scripts (root directory only)
+/debug_*.py
+
+# Ad-hoc test scripts (root directory only - tests/ is tracked)
+/test_*.py
+/test_*.sh
+
+# Temporary output files
+*_output.txt
+*_test_*.txt
+
+# SQLite temporary directories
+sqlite:/
+
+# Local documentation (personal/development notes)
+local-docs/
+
+# MkDocs build output
+site/
+
+# Cache directories
+.cache/

edda_framework-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

edda_framework-0.1.0/Justfile

@@ -0,0 +1,131 @@
+# Edda - Development Commands
+# Run `just` to see available commands
+
+# Default recipe - show available commands
+default:
+    @just --list
+
+# Install development dependencies
+install:
+    uv sync --extra dev
+
+# Install all dependencies including database drivers
+install-all:
+    uv sync --extra dev --extra postgresql --extra mysql
+
+# Install viewer dependencies
+install-viewer:
+    uv sync --extra viewer
+
+# Run tests with coverage
+test:
+    uv run python -m pytest
+
+# Run tests without coverage (faster)
+test-fast:
+    uv run python -m pytest --no-cov
+
+# Run specific test file
+test-file FILE:
+    uv run python -m pytest {{FILE}} --no-cov -v
+
+# Format code with black
+format:
+    uv run black edda tests
+
+# Check code formatting
+format-check:
+    uv run black --check edda tests
+
+# Lint code with ruff
+lint:
+    uv run ruff check edda tests
+
+# Type check with mypy
+type-check:
+    uv run mypy edda
+
+# Run all checks (format, lint, type-check, test)
+check: format-check lint type-check test
+
+# Auto-fix issues (format + lint with auto-fix)
+fix:
+    uv run black edda tests
+    uv run ruff check --fix edda tests
+
+# Run demo application (installs dependencies if needed)
+demo:
+    @echo "Stopping existing demo app on port 8001..."
+    @lsof -ti :8001 | xargs kill -15 2>/dev/null || true
+    @sleep 1
+    @lsof -ti :8001 | xargs kill -9 2>/dev/null || true
+    @echo "Ensuring server dependencies are installed..."
+    @uv sync --extra server --quiet
+    uv run tsuno demo_app:application --bind 127.0.0.1:8001
+
+# Run demo application with PostgreSQL (requires local PostgreSQL)
+# Usage: just demo-postgresql
+# Requires: EDDA_POSTGRES_PASSWORD environment variable
+demo-postgresql:
+    @echo "Stopping existing demo app on port 8001..."
+    @lsof -ti :8001 | xargs kill -15 2>/dev/null || true
+    @sleep 1
+    @lsof -ti :8001 | xargs kill -9 2>/dev/null || true
+    @echo "Ensuring server and PostgreSQL dependencies are installed..."
+    @uv sync --extra server --extra postgresql --quiet
+    @echo "Starting demo app with PostgreSQL..."
+    EDDA_DB_URL="postgresql+asyncpg://postgres:{{env_var('EDDA_POSTGRES_PASSWORD')}}@localhost:5432/edda" \
+    uv run tsuno demo_app:application --bind 127.0.0.1:8001
+
+# Run viewer with demo_app using PostgreSQL (requires local PostgreSQL)
+# Usage: just demo-postgresql-viewer [PORT]
+# Requires: EDDA_POSTGRES_PASSWORD environment variable
+demo-postgresql-viewer PORT='8080':
+    @echo "Stopping existing viewer on port {{PORT}}..."
+    @lsof -ti :{{PORT}} | xargs kill -15 2>/dev/null || true
+    @sleep 1
+    @lsof -ti :{{PORT}} | xargs kill -9 2>/dev/null || true
+    @echo "Ensuring viewer and PostgreSQL dependencies are installed..."
+    @uv sync --extra viewer --extra postgresql --quiet
+    @echo "Starting viewer with PostgreSQL and demo_app..."
+    EDDA_DB_URL="postgresql+asyncpg://postgres:{{env_var('EDDA_POSTGRES_PASSWORD')}}@localhost:5432/edda" \
+    uv run edda-viewer --port {{PORT}} --import-module demo_app
+
+# Run viewer application (installs dependencies if needed)
+# Usage: just viewer [DB] [PORT] [MODULES]
+# Examples:
+#   just viewer                                  # No modules, demo.db, port 8080
+#   just viewer my.db                            # Custom DB, no modules
+#   just viewer demo.db 8080 "-m demo_app"       # With demo_app module
+#   just viewer demo.db 8080 "-m demo_app -m my_app"  # Multiple modules
+viewer DB='demo.db' PORT='8080' MODULES='':
+    @echo "Stopping existing viewer on port {{PORT}}..."
+    @lsof -ti :{{PORT}} | xargs kill -15 2>/dev/null || true
+    @sleep 1
+    @lsof -ti :{{PORT}} | xargs kill -9 2>/dev/null || true
+    @echo "Ensuring viewer dependencies are installed..."
+    @uv sync --extra viewer --quiet
+    uv run edda-viewer --db {{DB}} --port {{PORT}} {{MODULES}}
+
+# Run viewer with demo_app (shortcut)
+# Usage: just viewer-demo [DB] [PORT]
+# Examples:
+#   just viewer-demo              # demo.db, port 8080, with demo_app
+#   just viewer-demo my.db 9000   # Custom DB and port, with demo_app
+viewer-demo DB='demo.db' PORT='8080':
+    just viewer {{DB}} {{PORT}} "--import-module demo_app"
+
+
+# Clean build artifacts and caches
+clean:
+    rm -rf .pytest_cache
+    rm -rf htmlcov
+    rm -rf .coverage
+    rm -rf .mypy_cache
+    rm -rf .ruff_cache
+    rm -rf dist
+    rm -rf build
+    rm -rf *.egg-info
+    find . -type d -name __pycache__ -exec rm -rf {} +
+    find . -type f -name "*.pyc" -delete
+    rm -f demo.db

edda_framework-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yasushi Itoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.