pgframx 0.1.0__tar.gz

pgframx-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 pgwiz
+
+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.

pgframx-0.1.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: pgframx
+Version: 0.1.0
+Summary: Flask-based event management orchestration framework
+Project-URL: Homepage, https://github.com/pgwiz/pgframx
+Project-URL: Repository, https://github.com/pgwiz/pgframx
+Author-email: pgwiz <peter@wiptech.co.ke>
+License: MIT License
+        
+        Copyright (c) 2026 pgwiz
+        
+        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.
+License-File: LICENSE
+Keywords: events,flask,framework,orchestration,scheduler
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Requires-Dist: apscheduler>=3.10.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: flask>=3.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: requests>=2.28.0
+Description-Content-Type: text/markdown
+
+# pgframx
+
+**Flask-based event management orchestration framework.**
+
+Orchestrate events, not chaos.
+
+## Install
+
+```bash
+pip install pgframx
+```
+
+## Quickstart
+
+```python
+from pgframx import Orchestrator, create_app
+
+orc = Orchestrator()
+
+@orc.on("order.placed")
+def handle_order(event):
+    print(f"Order received: {event.data}")
+
+app = create_app(orc)
+
+if __name__ == "__main__":
+    app.run(port=5050)
+```
+
+## CLI
+
+```bash
+pgframx init        # Create a new project scaffold in current directory
+pgframx run         # Start the Flask orchestrator server
+pgframx emit <event> --data '{}'  # Emit event from CLI to running server
+pgframx list events               # List all registered events
+pgframx list listeners            # List all registered listeners
+pgframx schedule list             # List scheduled cron/interval jobs
+pgframx schedule add <event> --interval 10  # Schedule recurring events
+pgframx schedule remove <job_id>  # Remove scheduled jobs
+```
+
+## Features
+- **Decorators**: Event registration, before hooks, and after hooks.
+- **Wildcard matching**: Match events using wildcards (`user.*`).
+- **Scheduling**: Chronological/interval-based triggers via APScheduler.
+- **REST API**: Mountable blueprints exposing route endpoints for events, listeners, and health checks.
+- **Dynamic Webhooks**: Register webhooks dynamically via the REST API or CLI.
+- **Full CLI**: Manage your event broker process from the terminal.

pgframx-0.1.0/README.md

@@ -0,0 +1,49 @@
+# pgframx
+
+**Flask-based event management orchestration framework.**
+
+Orchestrate events, not chaos.
+
+## Install
+
+```bash
+pip install pgframx
+```
+
+## Quickstart
+
+```python
+from pgframx import Orchestrator, create_app
+
+orc = Orchestrator()
+
+@orc.on("order.placed")
+def handle_order(event):
+    print(f"Order received: {event.data}")
+
+app = create_app(orc)
+
+if __name__ == "__main__":
+    app.run(port=5050)
+```
+
+## CLI
+
+```bash
+pgframx init        # Create a new project scaffold in current directory
+pgframx run         # Start the Flask orchestrator server
+pgframx emit <event> --data '{}'  # Emit event from CLI to running server
+pgframx list events               # List all registered events
+pgframx list listeners            # List all registered listeners
+pgframx schedule list             # List scheduled cron/interval jobs
+pgframx schedule add <event> --interval 10  # Schedule recurring events
+pgframx schedule remove <job_id>  # Remove scheduled jobs
+```
+
+## Features
+- **Decorators**: Event registration, before hooks, and after hooks.
+- **Wildcard matching**: Match events using wildcards (`user.*`).
+- **Scheduling**: Chronological/interval-based triggers via APScheduler.
+- **REST API**: Mountable blueprints exposing route endpoints for events, listeners, and health checks.
+- **Dynamic Webhooks**: Register webhooks dynamically via the REST API or CLI.
+- **Full CLI**: Manage your event broker process from the terminal.

pgframx-0.1.0/README_eventflow.md

@@ -0,0 +1,143 @@
+# EventFlow — Business Event Management System
+### Built on FastAPI · KATTI National Skills Competition 2026
+
+A full-stack web application for business event management — covering database design,
+backend APIs, frontend UI, authentication, reporting, and code quality.
+
+---
+
+## Tech Stack
+
+| Layer | Tech |
+|---|---|
+| Backend | FastAPI (Python 3.11+) |
+| Database | SQLite (dev) / PostgreSQL (prod) — via SQLAlchemy async |
+| Auth | JWT (access + refresh tokens), bcrypt passwords |
+| Frontend | Vanilla JS SPA served by FastAPI |
+| File uploads | aiofiles + Pillow |
+
+---
+
+## Setup (8-hour competition mode)
+
+```bash
+# 1. Clone / unzip project
+cd eventflow
+
+# 2. Create virtualenv
+python -m venv venv
+source venv/bin/activate      # Windows: venv\Scripts\activate
+
+# 3. Install dependencies
+pip install -r requirements.txt
+
+# 4. (Optional) copy env
+cp .env.example .env          # edit SECRET_KEY
+
+# 5. Run
+uvicorn app.main:app --reload --port 8000
+```
+
+Open **http://localhost:8000/admin** — first registered user becomes admin.
+
+API docs: **http://localhost:8000/docs**
+
+---
+
+## API Endpoints
+
+### Auth
+| Method | Path | Description |
+|---|---|---|
+| POST | /api/v1/auth/register | Register user |
+| POST | /api/v1/auth/login | Login (returns JWT) |
+| GET  | /api/v1/auth/me | Current user info |
+
+### Events
+| Method | Path | Description |
+|---|---|---|
+| GET    | /api/v1/events | List events (paginated, filterable) |
+| POST   | /api/v1/events | Create event |
+| GET    | /api/v1/events/{id} | Get event detail |
+| PUT    | /api/v1/events/{id} | Update event |
+| DELETE | /api/v1/events/{id} | Delete event |
+| POST   | /api/v1/events/{id}/register | Register for event |
+| GET    | /api/v1/events/{id}/registrations | List registrations |
+| POST   | /api/v1/events/{id}/checkin/{ticket_ref} | Check-in attendee |
+
+### Reports
+| Method | Path | Description |
+|---|---|---|
+| GET | /api/v1/reports/dashboard | Dashboard stats |
+| GET | /api/v1/reports/events/{id}/attendance | Event attendance report |
+| GET | /api/v1/reports/registrations/by-status | Status breakdown |
+| GET | /api/v1/reports/revenue/monthly | Monthly revenue |
+
+### Supporting
+- `/api/v1/categories` — CRUD categories
+- `/api/v1/tags` — CRUD tags
+- `/api/v1/media/upload` — File upload (POST), list (GET)
+- `/api/v1/users` — User management
+- `/api/v1/settings` — Key-value settings store
+
+---
+
+## User Roles
+
+| Role | Can Do |
+|---|---|
+| admin | Everything |
+| organizer | Create/edit own events, view registrations, check-in |
+| attendee | Register for published events, view own registrations |
+| viewer | Read-only access to published events |
+
+---
+
+## Hook System (WordPress-style)
+
+```python
+from app.hooks.registry import hook_registry
+
+# Fire when event is published
+@hook_registry.action("event_create")
+def send_notification(event, **kwargs):
+    print(f"New event: {event.title}")
+
+# Filter event content before save
+@hook_registry.filter("post_content")
+def sanitize(content, **kwargs):
+    return content.strip()
+```
+
+---
+
+## Project Structure
+
+```
+eventflow/
+├── app/
+│   ├── main.py              # FastAPI app + route mounting
+│   ├── core/
+│   │   ├── config.py        # Settings (pydantic-settings)
+│   │   ├── database.py      # Async SQLAlchemy engine + session
+│   │   └── security.py      # JWT + password hashing
+│   ├── models/
+│   │   └── __init__.py      # All SQLAlchemy models
+│   ├── api/v1/endpoints/
+│   │   ├── auth.py          # Login, register, /me
+│   │   ├── posts.py         # Events CRUD + registration + check-in
+│   │   ├── users.py         # User management
+│   │   ├── categories.py    # Category CRUD
+│   │   ├── tags.py          # Tag CRUD
+│   │   ├── media.py         # File upload + media library
+│   │   ├── pages.py         # Static pages
+│   │   ├── settings.py      # Key-value settings
+│   │   └── reports.py       # Analytics + reports
+│   └── hooks/
+│       └── registry.py      # Action/filter hook system
+├── static/
+│   └── admin.html           # Admin SPA (dark luxury UI)
+├── uploads/                 # Media file storage
+├── requirements.txt
+└── README.md
+```