Metadata-Version: 2.4
Name: pgframx
Version: 0.2.2
Summary: Flask-based event management orchestration framework with scaffold generator
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: auth,events,flask,generator,orchestration,reporting,scaffold
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-jwt-extended>=4.6.0
Requires-Dist: flask-login>=0.6.0
Requires-Dist: flask-migrate>=4.0.0
Requires-Dist: flask-sqlalchemy>=3.1.0
Requires-Dist: flask>=3.0.0
Requires-Dist: jinja2>=3.1.0
Requires-Dist: pymysql>=1.1.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: reportlab>=4.1.0
Requires-Dist: requests>=2.28.0
Requires-Dist: sqlalchemy>=2.0.0
Requires-Dist: werkzeug>=3.0.0
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Provides-Extra: postgres
Requires-Dist: psycopg2-binary>=2.9.0; extra == 'postgres'
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.
