aegis-stack 0.2.0rc2__py3-none-any.whl

aegis/templates/copier-aegis-project/{{ project_slug }}/README.md.jinja

@@ -0,0 +1,196 @@
+# {{ project_name }} 🛡️
+
+{{ project_description }}
+
+## Components
+
+This Aegis Stack project includes the following components:
+
+- **✅ Backend**: FastAPI-based async web server
+- **✅ Frontend**: Flet-based Python UI framework
+{%- if include_scheduler %}
+- **✅ Scheduler**: APScheduler-based async task scheduling
+{%- endif %}
+{%- if include_database %}
+- **✅ Database**: SQLite database with SQLModel ORM
+{%- endif %}
+{%- if include_cache %}
+- **✅ Cache**: Redis-based async caching
+{%- endif %}
+
+## Getting Started
+
+### Prerequisites
+
+- Python {{ python_version }}+
+- [uv](https://docs.astral.sh/uv/) (recommended) or pip
+
+### Installation
+
+1. **Install dependencies:**
+   ```bash
+   uv sync                    # Core dependencies only
+   # Or for development: uv sync --all-extras  (includes testing, linting, docs)
+   ```
+
+2. **Activate virtual environment:**
+   ```bash
+   source .venv/bin/activate
+   ```
+
+3. **Set up environment:**
+   ```bash
+   cp .env.example .env
+   # Edit .env with your configuration
+   ```
+
+{%- if include_database %}
+
+4. **Set up database:**
+   ```bash
+   # Create data directory for SQLite database
+   mkdir -p data
+
+   # Database will be created automatically on first run
+   # Default location: data/app.db
+   ```
+
+5. **Run the application:**
+{%- else %}
+
+4. **Run the application:**
+{%- endif %}
+   ```bash
+   make server
+   ```
+
+The application will be available at `http://127.0.0.1:8000`.
+
+## Development
+
+### Running Tests
+```bash
+make test
+```
+
+### Code Quality
+```bash
+make check  # Run linting, type checking, and tests
+```
+
+### CLI Commands
+
+Your project gets its own CLI command **automatically installed** when first used - no setup required! 🎉
+
+```bash
+# Health monitoring (auto-installs CLI if needed)
+make health                     # Basic health check
+make health-detailed            # Detailed component status
+make health-json               # JSON output for scripts
+make health-quick              # Quick healthy/unhealthy check
+
+# Direct CLI usage (after first make command)
+{{ project_slug }} health check              # Basic health check
+{{ project_slug }} health check --detailed   # Detailed component status
+{{ project_slug }} health check --json       # JSON output for scripts
+{{ project_slug }} health quick              # Quick healthy/unhealthy check
+
+# Explore all commands
+{{ project_slug }} --help                    # See all available commands
+{{ project_slug }} health --help             # See health subcommand options
+```
+
+**Environment Issues?** If CLI commands don't work:
+```bash
+# Ensure you're in the project's virtual environment
+unset VIRTUAL_ENV               # Clear Docker contamination
+source .venv/bin/activate       # Activate local venv
+make health                     # This will auto-install CLI
+# Or manually: make install-cli
+```
+
+### Documentation
+```bash
+make docs-serve  # Serve docs at http://localhost:8001/{{ project_slug }}/
+```
+
+## Docker
+
+### Development
+```bash
+docker compose --profile dev up
+```
+
+### Production
+```bash
+docker compose --profile prod up
+```
+
+{%- if include_database %}
+
+## Configuration
+
+### Database Settings
+
+The database component uses SQLite with the following default configuration:
+
+```bash
+# Environment variables (add to .env file)
+DATABASE_URL=sqlite:///data/app.db          # Database file location
+DATABASE_ENGINE_ECHO=false                  # Enable SQL query logging
+```
+
+### Database Usage
+
+```python
+from app.core.db import db_session
+from sqlmodel import SQLModel, Field, select
+
+# Define a model
+class User(SQLModel, table=True):
+    id: int | None = Field(default=None, primary_key=True)
+    name: str
+    email: str
+
+# Use the database
+with db_session() as session:
+    user = User(name="John Doe", email="john@example.com")
+    session.add(user)
+    # Auto-committed by context manager
+```
+
+{%- endif %}
+
+## Project Structure
+
+```
+{{ project_slug }}/
+├── app/                    # Application code
+│   ├── components/         # Component implementations
+│   │   ├── backend/       # FastAPI backend
+│   │   └── frontend/      # Flet frontend
+{%- if include_scheduler %}
+│   │   └── scheduler/     # APScheduler background tasks
+{%- endif %}
+│   ├── cli/               # CLI commands and health monitoring
+│   ├── core/              # Core utilities
+│   │   ├── config.py      # Environment-dependent configuration
+│   │   ├── constants.py   # Immutable constants (12-Factor App)
+{%- if include_database %}
+│   │   ├── db.py          # Database connection and session management
+{%- endif %}
+│   │   └── log.py         # Structured logging
+│   ├── entrypoints/       # Execution entry points
+│   ├── integrations/      # App composition layer
+{%- if _has_additional_components %}
+│   └── services/          # Business logic services
+{%- endif %}
+├── tests/                 # Test suite
+├── docs/                  # Documentation
+├── docker-compose.yml     # Docker services
+└── pyproject.toml        # Project configuration
+```
+
+---
+
+Generated with [Aegis Stack](https://github.com/lbedner/aegis-stack) 🛡️

aegis/templates/copier-aegis-project/{{ project_slug }}/alembic/alembic.ini.jinja

@@ -0,0 +1,111 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version number format. This value is passed to the
+# strftime() function and is used to generate revision timestamps.
+# version_num_format = %%(year)d%%(month).2d%%(day).2d_%%(hour).2d%%(minute).2d
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses
+# os.pathsep. If this key is omitted entirely, it falls back to the legacy
+# behavior of splitting on spaces and/or commas.
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# format using "ruff" - use the console_scripts runner, against the "ruff" entrypoint
+# hooks = ruff
+# ruff.type = console_scripts
+# ruff.entrypoint = ruff
+# ruff.options = format REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

aegis/templates/copier-aegis-project/{{ project_slug }}/alembic/env.py.jinja

@@ -0,0 +1,91 @@
+"""
+Alembic environment configuration for SQLModel integration.
+
+This module configures Alembic to work with SQLModel and ensures
+proper metadata detection for autogenerate functionality.
+"""
+
+# ruff: noqa: I001
+from logging.config import fileConfig
+import sys
+from pathlib import Path
+
+from sqlalchemy import engine_from_config, pool
+
+from alembic import context
+
+# Add project root to path for imports
+project_root = Path(__file__).parent.parent
+sys.path.insert(0, str(project_root))
+
+# Import SQLModel and models to register metadata
+from sqlmodel import SQLModel  # noqa: E402
+from app.core.config import settings  # noqa: E402
+{% if include_auth %}
+from app.models.user import User  # noqa: E402,F401
+{% endif %}
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# Set the SQLAlchemy URL from our settings
+config.set_main_option("sqlalchemy.url", settings.DATABASE_URL)
+
+# Set target metadata to SQLModel.metadata
+target_metadata = SQLModel.metadata
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well. By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

aegis/templates/copier-aegis-project/{{ project_slug }}/alembic/script.py.mako

@@ -0,0 +1,25 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

aegis/templates/copier-aegis-project/{{ project_slug }}/alembic/versions/001_initial_auth.py.jinja

@@ -0,0 +1,51 @@
+"""Initial auth schema
+
+Revision ID: 001
+Revises:
+Create Date: 2025-01-18 00:00:00.000000
+
+"""
+from datetime import UTC, datetime
+
+import sqlalchemy as sa
+import sqlmodel
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = '001'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Create initial auth tables."""
+    # Create user table
+    op.create_table(
+        'user',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('email', sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column('full_name', sqlmodel.sql.sqltypes.AutoString(), nullable=True),
+        sa.Column('is_active', sa.Boolean(), nullable=False, default=True),
+        sa.Column(
+            'hashed_password', sqlmodel.sql.sqltypes.AutoString(), nullable=False
+        ),
+        sa.Column(
+            'created_at',
+            sa.DateTime(),
+            nullable=False,
+            default=lambda: datetime.now(UTC),
+        ),
+        sa.Column('updated_at', sa.DateTime(), nullable=True),
+        sa.PrimaryKeyConstraint('id')
+    )
+
+    # Create indexes
+    op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
+
+
+def downgrade() -> None:
+    """Drop auth tables."""
+    op.drop_index(op.f('ix_user_email'), table_name='user')
+    op.drop_table('user')

aegis/templates/copier-aegis-project/{{ project_slug }}/app/__init__.py.jinja

@@ -0,0 +1,5 @@
+"""
+{{ project_name }} - Main application package.
+"""
+
+__version__ = "{{ version }}"

aegis/templates/copier-aegis-project/{{ project_slug }}/app/cli/__init__.py.jinja

@@ -0,0 +1,6 @@
+"""
+CLI management commands for {{ project_name }}.
+
+This module provides command-line utilities for managing and monitoring
+the application outside of the main runtime components.
+"""