skrift 0.1.0a1__tar.gz

skrift-0.1.0a1/.gitignore

@@ -0,0 +1,24 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Environment variables
+.env
+
+# Database
+*.db
+
+# IDE
+.idea/
+
+# App configuration (generated by setup wizard)
+app.yaml
+app.bak.yaml
+app.yaml.backup.*

skrift-0.1.0a1/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: skrift
+Version: 0.1.0a1
+Summary: A lightweight async Python CMS for crafting modern websites
+Requires-Python: >=3.13
+Requires-Dist: advanced-alchemy>=0.26.0
+Requires-Dist: aiosqlite>=0.20.0
+Requires-Dist: alembic>=1.14.0
+Requires-Dist: asyncpg>=0.30.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: litestar[cryptography,jinja,standard]>=2.14.0
+Requires-Dist: pydantic-settings>=2.7.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: ruamel-yaml>=0.18.0
+Requires-Dist: sqlalchemy[asyncio]>=2.0.36
+Requires-Dist: uvicorn>=0.34.0
+Description-Content-Type: text/markdown
+
+# Skrift
+
+A modern Litestar-powered content management framework with multi-provider OAuth authentication, role-based access control, and WordPress-like template resolution.
+
+## Features
+
+- **Multi-Provider OAuth**: Authenticate with Google, GitHub, Microsoft, Discord, Facebook, or Twitter/X
+- **Role-Based Access Control**: Flexible permission system with Admin, Editor, Author, and Moderator roles
+- **Setup Wizard**: Guided first-time configuration without manual file editing
+- **Admin Interface**: Web-based management for users, pages, and site settings
+- **WordPress-like Templates**: Hierarchical template resolution for content pages
+- **Dynamic Controllers**: Load controllers from `app.yaml` configuration
+- **SQLAlchemy Integration**: Async database support with SQLite/PostgreSQL
+- **Client-Side Sessions**: Encrypted cookie sessions for horizontal scalability
+
+## Quick Start
+
+### Prerequisites
+
+- Python 3.13+
+
+### Installation
+
+```bash
+# Install Skrift
+pip install skrift
+
+# Or install from git
+pip install git+https://github.com/ZechCodes/skrift.git
+```
+
+### Getting Started
+
+Create a project directory and set up your environment:
+
+```bash
+mkdir mysite && cd mysite
+
+# Create minimal environment file
+echo "SECRET_KEY=$(python -c 'import secrets; print(secrets.token_urlsafe(32))')" > .env
+
+# Start Skrift
+skrift
+```
+
+Open http://localhost:8080 to launch the setup wizard.
+
+### Setup Wizard
+
+The setup wizard guides you through initial configuration:
+
+1. **Database Configuration**: Choose SQLite (dev) or PostgreSQL (production)
+2. **Authentication Providers**: Configure OAuth credentials
+3. **Site Settings**: Set site name, tagline, and copyright info
+4. **Admin Account**: Create your first admin user via OAuth login
+
+After completing the wizard, an `app.yaml` configuration file is created in your project directory.
+
+### Manual Configuration
+
+Alternatively, create `app.yaml` manually:
+
+```yaml
+controllers:
+  - skrift.controllers.auth:AuthController
+  - skrift.admin.controller:AdminController
+  - skrift.controllers.web:WebController
+
+db:
+  url: sqlite+aiosqlite:///./app.db
+
+auth:
+  redirect_base_url: http://localhost:8080
+  providers:
+    google:
+      client_id: $GOOGLE_CLIENT_ID
+      client_secret: $GOOGLE_CLIENT_SECRET
+      scopes: [openid, email, profile]
+```
+
+Then run migrations and start the server:
+
+```bash
+skrift-db upgrade head
+skrift
+```
+
+## Documentation
+
+- **[Full Documentation](docs/README.md)**: Comprehensive guide covering all features
+- **[Deployment Guide](docs/deployment.md)**: VPS, Docker, and Kubernetes deployment
+- **[CSS Framework](docs/css-framework.md)**: Styling documentation
+
+## Project Structure
+
+```
+skrift/
+├── skrift/              # Main Python package
+│   ├── asgi.py          # Application factory
+│   ├── config.py        # Settings management
+│   ├── controllers/     # Route handlers
+│   ├── admin/           # Admin panel
+│   ├── auth/            # RBAC and guards
+│   ├── db/              # Models and services
+│   ├── lib/             # Template resolver
+│   └── setup/           # Setup wizard
+├── templates/           # Jinja2 templates
+├── static/              # Static assets
+├── alembic/             # Database migrations
+├── docs/                # Documentation
+├── app.yaml             # Application config (generated)
+└── main.py              # Development entry point
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `SECRET_KEY` | Yes | Session encryption key |
+| `DEBUG` | No | Enable debug mode (default: false) |
+| `DATABASE_URL` | No | Database connection string |
+| `OAUTH_REDIRECT_BASE_URL` | No | OAuth callback base URL |
+
+OAuth credentials are configured per-provider (e.g., `GOOGLE_CLIENT_ID`, `GOOGLE_CLIENT_SECRET`).
+
+### app.yaml
+
+Application configuration is stored in `app.yaml` (generated by setup wizard):
+
+```yaml
+controllers:
+  - skrift.controllers.auth:AuthController
+  - skrift.admin.controller:AdminController
+  - skrift.controllers.web:WebController
+
+db:
+  url: $DATABASE_URL
+  pool_size: 5
+
+auth:
+  redirect_base_url: $OAUTH_REDIRECT_BASE_URL
+  providers:
+    google:
+      client_id: $GOOGLE_CLIENT_ID
+      client_secret: $GOOGLE_CLIENT_SECRET
+```
+
+Environment variables (prefixed with `$`) are interpolated at runtime.
+
+## Deployment
+
+### Minimal VPS Deployment
+
+```bash
+# Install Skrift
+pip install skrift
+
+# Create project directory
+mkdir -p /opt/skrift && cd /opt/skrift
+
+# Configure environment
+cat > .env << EOF
+SECRET_KEY=$(python -c "import secrets; print(secrets.token_urlsafe(32))")
+DATABASE_URL=sqlite+aiosqlite:///./app.db
+OAUTH_REDIRECT_BASE_URL=https://yourdomain.com
+EOF
+
+# Start server (use setup wizard or create app.yaml manually)
+skrift
+```
+
+### Production with Gunicorn
+
+```bash
+pip install gunicorn
+gunicorn skrift.asgi:app -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8080
+```
+
+See the [Deployment Guide](docs/deployment.md) for detailed instructions including Docker, Docker Compose, and Kubernetes deployments.
+
+## Database Migrations
+
+```bash
+# Apply migrations
+skrift-db upgrade head
+
+# Create new migration
+skrift-db revision --autogenerate -m "description"
+
+# Rollback
+skrift-db downgrade -1
+```
+
+## Template Resolution
+
+Templates follow WordPress-like hierarchical resolution:
+
+| URL Path | Templates Tried |
+|----------|-----------------|
+| `/about` | `page-about.html` -> `page.html` |
+| `/services/web` | `page-services-web.html` -> `page-services.html` -> `page.html` |
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+## License
+
+MIT

skrift-0.1.0a1/README.md

@@ -0,0 +1,214 @@
+# Skrift
+
+A modern Litestar-powered content management framework with multi-provider OAuth authentication, role-based access control, and WordPress-like template resolution.
+
+## Features
+
+- **Multi-Provider OAuth**: Authenticate with Google, GitHub, Microsoft, Discord, Facebook, or Twitter/X
+- **Role-Based Access Control**: Flexible permission system with Admin, Editor, Author, and Moderator roles
+- **Setup Wizard**: Guided first-time configuration without manual file editing
+- **Admin Interface**: Web-based management for users, pages, and site settings
+- **WordPress-like Templates**: Hierarchical template resolution for content pages
+- **Dynamic Controllers**: Load controllers from `app.yaml` configuration
+- **SQLAlchemy Integration**: Async database support with SQLite/PostgreSQL
+- **Client-Side Sessions**: Encrypted cookie sessions for horizontal scalability
+
+## Quick Start
+
+### Prerequisites
+
+- Python 3.13+
+
+### Installation
+
+```bash
+# Install Skrift
+pip install skrift
+
+# Or install from git
+pip install git+https://github.com/ZechCodes/skrift.git
+```
+
+### Getting Started
+
+Create a project directory and set up your environment:
+
+```bash
+mkdir mysite && cd mysite
+
+# Create minimal environment file
+echo "SECRET_KEY=$(python -c 'import secrets; print(secrets.token_urlsafe(32))')" > .env
+
+# Start Skrift
+skrift
+```
+
+Open http://localhost:8080 to launch the setup wizard.
+
+### Setup Wizard
+
+The setup wizard guides you through initial configuration:
+
+1. **Database Configuration**: Choose SQLite (dev) or PostgreSQL (production)
+2. **Authentication Providers**: Configure OAuth credentials
+3. **Site Settings**: Set site name, tagline, and copyright info
+4. **Admin Account**: Create your first admin user via OAuth login
+
+After completing the wizard, an `app.yaml` configuration file is created in your project directory.
+
+### Manual Configuration
+
+Alternatively, create `app.yaml` manually:
+
+```yaml
+controllers:
+  - skrift.controllers.auth:AuthController
+  - skrift.admin.controller:AdminController
+  - skrift.controllers.web:WebController
+
+db:
+  url: sqlite+aiosqlite:///./app.db
+
+auth:
+  redirect_base_url: http://localhost:8080
+  providers:
+    google:
+      client_id: $GOOGLE_CLIENT_ID
+      client_secret: $GOOGLE_CLIENT_SECRET
+      scopes: [openid, email, profile]
+```
+
+Then run migrations and start the server:
+
+```bash
+skrift-db upgrade head
+skrift
+```
+
+## Documentation
+
+- **[Full Documentation](docs/README.md)**: Comprehensive guide covering all features
+- **[Deployment Guide](docs/deployment.md)**: VPS, Docker, and Kubernetes deployment
+- **[CSS Framework](docs/css-framework.md)**: Styling documentation
+
+## Project Structure
+
+```
+skrift/
+├── skrift/              # Main Python package
+│   ├── asgi.py          # Application factory
+│   ├── config.py        # Settings management
+│   ├── controllers/     # Route handlers
+│   ├── admin/           # Admin panel
+│   ├── auth/            # RBAC and guards
+│   ├── db/              # Models and services
+│   ├── lib/             # Template resolver
+│   └── setup/           # Setup wizard
+├── templates/           # Jinja2 templates
+├── static/              # Static assets
+├── alembic/             # Database migrations
+├── docs/                # Documentation
+├── app.yaml             # Application config (generated)
+└── main.py              # Development entry point
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `SECRET_KEY` | Yes | Session encryption key |
+| `DEBUG` | No | Enable debug mode (default: false) |
+| `DATABASE_URL` | No | Database connection string |
+| `OAUTH_REDIRECT_BASE_URL` | No | OAuth callback base URL |
+
+OAuth credentials are configured per-provider (e.g., `GOOGLE_CLIENT_ID`, `GOOGLE_CLIENT_SECRET`).
+
+### app.yaml
+
+Application configuration is stored in `app.yaml` (generated by setup wizard):
+
+```yaml
+controllers:
+  - skrift.controllers.auth:AuthController
+  - skrift.admin.controller:AdminController
+  - skrift.controllers.web:WebController
+
+db:
+  url: $DATABASE_URL
+  pool_size: 5
+
+auth:
+  redirect_base_url: $OAUTH_REDIRECT_BASE_URL
+  providers:
+    google:
+      client_id: $GOOGLE_CLIENT_ID
+      client_secret: $GOOGLE_CLIENT_SECRET
+```
+
+Environment variables (prefixed with `$`) are interpolated at runtime.
+
+## Deployment
+
+### Minimal VPS Deployment
+
+```bash
+# Install Skrift
+pip install skrift
+
+# Create project directory
+mkdir -p /opt/skrift && cd /opt/skrift
+
+# Configure environment
+cat > .env << EOF
+SECRET_KEY=$(python -c "import secrets; print(secrets.token_urlsafe(32))")
+DATABASE_URL=sqlite+aiosqlite:///./app.db
+OAUTH_REDIRECT_BASE_URL=https://yourdomain.com
+EOF
+
+# Start server (use setup wizard or create app.yaml manually)
+skrift
+```
+
+### Production with Gunicorn
+
+```bash
+pip install gunicorn
+gunicorn skrift.asgi:app -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8080
+```
+
+See the [Deployment Guide](docs/deployment.md) for detailed instructions including Docker, Docker Compose, and Kubernetes deployments.
+
+## Database Migrations
+
+```bash
+# Apply migrations
+skrift-db upgrade head
+
+# Create new migration
+skrift-db revision --autogenerate -m "description"
+
+# Rollback
+skrift-db downgrade -1
+```
+
+## Template Resolution
+
+Templates follow WordPress-like hierarchical resolution:
+
+| URL Path | Templates Tried |
+|----------|-----------------|
+| `/about` | `page-about.html` -> `page.html` |
+| `/services/web` | `page-services-web.html` -> `page-services.html` -> `page.html` |
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+## License
+
+MIT

skrift-0.1.0a1/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "skrift"
+version = "0.1.0a1"
+description = "A lightweight async Python CMS for crafting modern websites"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "litestar[standard,jinja,cryptography]>=2.14.0",
+    "sqlalchemy[asyncio]>=2.0.36",
+    "aiosqlite>=0.20.0",
+    "asyncpg>=0.30.0",
+    "advanced-alchemy>=0.26.0",
+    "alembic>=1.14.0",
+    "httpx>=0.28.0",
+    "pydantic-settings>=2.7.0",
+    "python-dotenv>=1.0.0",
+    "uvicorn>=0.34.0",
+    "pyyaml>=6.0.0",
+    "ruamel.yaml>=0.18.0",
+]
+
+[project.scripts]
+skrift = "skrift.__main__:main"
+skrift-db = "skrift.cli:db"
+
+[tool.uv]
+package = true
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+include = [
+    "skrift/**/*.py",
+    "skrift/templates/**/*.html",
+    "skrift/static/**/*",
+    "skrift/alembic/**/*",
+    "skrift/alembic.ini",
+]
+exclude = [
+    "**/__pycache__",
+    "**/*.pyc",
+    "app.yaml",
+    "*.db",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py313"

skrift-0.1.0a1/skrift/__init__.py

@@ -0,0 +1 @@
+# Skrift application package

skrift-0.1.0a1/skrift/__main__.py

@@ -0,0 +1,17 @@
+"""Entry point for the skrift package."""
+
+import uvicorn
+
+
+def main():
+    """Run the Skrift development server."""
+    uvicorn.run(
+        "skrift.asgi:app",
+        host="0.0.0.0",
+        port=8080,
+        reload=True,
+    )
+
+
+if __name__ == "__main__":
+    main()

skrift-0.1.0a1/skrift/admin/__init__.py

@@ -0,0 +1,11 @@
+"""Admin module for administrative functionality."""
+
+from skrift.admin.controller import AdminController
+from skrift.admin.navigation import AdminNavItem, build_admin_nav, ADMIN_NAV_TAG
+
+__all__ = [
+    "AdminController",
+    "AdminNavItem",
+    "build_admin_nav",
+    "ADMIN_NAV_TAG",
+]