pgframx 0.2.0__tar.gz → 0.2.2__tar.gz

{pgframx-0.2.0 → pgframx-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pgframx
-Version: 0.2.0
+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

{pgframx-0.2.0 → pgframx-0.2.2}/memory.md

@@ -35,8 +35,8 @@ e:/Backup/pgwiz/event-mangr/
 │   ├── scheduler.py
 │   └── utils.py
 ├── dist/                       # Built wheels and source distributions
-│   ├── pgframx-0.1.0-py3-none-any.whl
-│   └── pgframx-0.1.0.tar.gz
+│   ├── pgframx-0.2.1-py3-none-any.whl
+│   └── pgframx-0.2.1.tar.gz
 ├── pyproject.toml
 ├── README.md                   # Updated pgframx README
 ├── README_eventflow.md         # Original EventFlow README
@@ -52,5 +52,7 @@ e:/Backup/pgwiz/event-mangr/
 ## Done Log
 - 2026-06-22: Created `memory.md` and initialized pgframx plan.
 - 2026-06-22: Completed development of core pgframx package, REST Blueprints, CLI, pyproject packaging configuration, ran local tests, generated the distribution bundle under `dist/`, and verified CLI scaffolding and control server execution.
-- 2026-06-22: Published pgframx 0.1.0 to PyPI.
+- 2026-06-22: Resolved scaffolder escaping bugs, layout offline compiling errors, and authentication cookie/JWT masking issues.
+- 2026-06-22: Successfully compiled and published pgframx version 0.2.0 to PyPI.
+- 2026-06-22: Resolved template layout rendering path mismatch (`TemplateNotFound: _base/layout.html.tpl`), populated empty auth/profile views, added template-specific SQLAlchemy models for all subtypes, and successfully published pgframx version 0.2.1 to PyPI.
 - 2026-06-22: Created `templates_ideas.md` detailing event software variants and styling schemas.

{pgframx-0.2.0 → pgframx-0.2.2}/pgframx/cli.py

@@ -53,12 +53,16 @@ def main():
     pass
 
 @main.command()
-@click.option("--template", default="general", help="Subtype template (general|conference|concert|hackathon|sports|social).")
-@click.option("--db", "db_choice", default="sqlite", help="Target database engine (sqlite|mysql|postgres).")
-@click.option("--auth", "auth_type", default="jwt", help="Auth system (jwt|session).")
+@click.option("--template", default="general", type=click.Choice(["general", "conference", "concert", "hackathon", "sports", "social"]), help="Event application template design schema.")
+@click.option("--db", "db_choice", default="sqlite", type=click.Choice(["sqlite", "mysql", "postgres"]), help="Target database management system.")
+@click.option("--auth", "auth_type", default="jwt", type=click.Choice(["jwt", "session"]), help="User authentication mechanism.")
 @click.option("--name", "project_name", default="my_app", help="Output directory and project name.")
 def init(template, db_choice, auth_type, project_name):
-    """Scaffold a new pgframx project in the target directory."""
+    """Scaffold a new pgframx project in the target directory.
+
+    Example:
+      pgframx init --name my_app --template conference --db sqlite --auth session
+    """
     click.echo(f"Scaffolding new pgframx project '{project_name}'...")
     click.echo(f"  Template : {template}")
     click.echo(f"  Database : {db_choice}")
@@ -88,7 +92,11 @@ def init(template, db_choice, auth_type, project_name):
 
 @main.command()
 def templates():
-    """List available templates."""
+    """List available project templates and their descriptions.
+
+    Example:
+      pgframx templates
+    """
     click.echo("Available pgframx Templates:")
     click.echo("  - general      ⭐ Universal core event catalog (DEFAULT)")
     click.echo("  - conference   Corporate summits, speaker agendas, and sponsors")
@@ -99,7 +107,11 @@ def templates():
 
 @main.command()
 def run():
-    """Start the Flask orchestrator server."""
+    """Start the Flask orchestrator server (looks for app.py or main.py).
+
+    Example:
+      pgframx run
+    """
     sys.path.insert(0, os.getcwd())
     
     app = None
@@ -146,10 +158,19 @@ def run():
 
 @main.command()
 @click.argument("event_name")
-@click.option("--data", default="{}", help="JSON string data payload.")
-@click.option("--async", "async_dispatch", is_flag=True, help="Emit event asynchronously.")
+@click.option("--data", default="{}", help="JSON payload string (default: '{}').")
+@click.option("--async", "async_dispatch", is_flag=True, help="Emit event asynchronously in a background thread.")
 def emit(event_name, data, async_dispatch):
-    """Emit event from CLI."""
+    """Emit a named event to the running orchestrator server.
+
+    Arguments:
+      EVENT_NAME  The event name to fire (supports dot-notation e.g. user.login)
+
+    Examples:
+      pgframx emit user.login
+      pgframx emit user.login --data '{"email": "admin@example.com"}'
+      pgframx emit system.cleanup --async
+    """
     url = f"{get_base_url()}/events/emit"
     try:
         parsed_data = json.loads(data)
@@ -174,12 +195,21 @@ def emit(event_name, data, async_dispatch):
 
 @main.group(name="list")
 def list_group():
-    """List resources (events, listeners)."""
+    """List registered resources from the running orchestrator server.
+
+    Examples:
+      pgframx list events
+      pgframx list listeners
+    """
     pass
 
 @list_group.command(name="events")
 def list_events():
-    """Print registered events."""
+    """Print all event patterns that have registered listeners.
+
+    Example:
+      pgframx list events
+    """
     url = f"{get_base_url()}/events"
     try:
         response = requests.get(url)
@@ -196,7 +226,11 @@ def list_events():
 
 @list_group.command(name="listeners")
 def list_listeners():
-    """Print registered listeners."""
+    """Print all registered event listeners (code callbacks and webhooks).
+
+    Example:
+      pgframx list listeners
+    """
     url = f"{get_base_url()}/listeners"
     try:
         response = requests.get(url)
@@ -220,12 +254,23 @@ def list_listeners():
 
 @main.group(name="schedule")
 def schedule_group():
-    """Manage scheduled jobs."""
+    """Manage recurring scheduled event jobs on the orchestrator.
+
+    Examples:
+      pgframx schedule list
+      pgframx schedule add ping.health --interval 60
+      pgframx schedule add nightly.report --cron '0 2 * * *'
+      pgframx schedule remove <job_id>
+    """
     pass
 
 @schedule_group.command(name="list")
 def list_jobs():
-    """List scheduled jobs."""
+    """List all active recurring jobs in the scheduler.
+
+    Example:
+      pgframx schedule list
+    """
     url = f"{get_base_url()}/health/scheduler"
     try:
         response = requests.get(url)
@@ -250,11 +295,20 @@ def list_jobs():
 
 @schedule_group.command(name="add")
 @click.argument("event_name")
-@click.option("--cron", default=None, help="Cron expression (e.g. '*/5 * * * *')")
-@click.option("--interval", default=None, type=int, help="Interval in seconds")
-@click.option("--data", default="{}", help="JSON string event data payload")
+@click.option("--cron", default=None, help="Cron expression (e.g. '*/5 * * * *' for every 5 mins).")
+@click.option("--interval", default=None, type=int, help="Interval in seconds (e.g. 60 for every minute).")
+@click.option("--data", default="{}", help="JSON payload to attach to the emitted event (default: '{}').")
 def add_job(event_name, cron, interval, data):
-    """Schedule a recurring event."""
+    """Schedule a recurring event job (by interval or cron expression).
+
+    Arguments:
+      EVENT_NAME  The event name to fire on each schedule tick.
+
+    Examples:
+      pgframx schedule add ping.health --interval 60
+      pgframx schedule add nightly.report --cron '0 2 * * *'
+      pgframx schedule add user.sync --interval 300 --data '{"source": "crm"}'
+    """
     url = f"{get_base_url()}/health/scheduler/jobs"
     try:
         parsed_data = json.loads(data)
@@ -281,7 +335,14 @@ def add_job(event_name, cron, interval, data):
 @schedule_group.command(name="remove")
 @click.argument("job_id")
 def remove_job(job_id):
-    """Remove a scheduled job by ID."""
+    """Remove a scheduled job from the scheduler by its job ID.
+
+    Arguments:
+      JOB_ID  The job identifier (shown in 'pgframx schedule list').
+
+    Example:
+      pgframx schedule remove abc123
+    """
     url = f"{get_base_url()}/health/scheduler/jobs/{job_id}"
     try:
         response = requests.delete(url)
@@ -294,14 +355,29 @@ def remove_job(job_id):
 
 @main.group(name="report")
 def report_group():
-    """Generate PDF reports directly from the database."""
+    """Generate PDF reports directly from the local project database.
+
+    Run from inside a scaffolded project folder (where .env and database.db live).
+
+    Examples:
+      pgframx report attendees --event-id 1
+      pgframx report attendees --event-id 2 --output reports/conf_attendees.pdf
+      pgframx report revenue --event-id 1
+      pgframx report events
+      pgframx report events --output reports/summary.pdf
+    """
     pass
 
 @report_group.command(name="attendees")
-@click.option("--event-id", type=int, required=True, help="ID of the event.")
-@click.option("--output", default="attendee_report.pdf", help="Output file path.")
+@click.option("--event-id", type=int, required=True, help="The database ID of the target event.")
+@click.option("--output", default="attendee_report.pdf", help="Output PDF file path (default: attendee_report.pdf).")
 def report_attendees(event_id, output):
-    """Generate PDF report of attendees for an event."""
+    """Generate a PDF list of all attendees registered for an event.
+
+    Examples:
+      pgframx report attendees --event-id 1
+      pgframx report attendees --event-id 3 --output exports/conf_attendees.pdf
+    """
     click.echo(f"Generating attendee report for Event #{event_id} at '{output}'...")
     session = get_cli_db_session()
     
@@ -315,10 +391,15 @@ def report_attendees(event_id, output):
         session.close()
 
 @report_group.command(name="revenue")
-@click.option("--event-id", type=int, required=True, help="ID of the event.")
-@click.option("--output", default="revenue_report.pdf", help="Output file path.")
+@click.option("--event-id", type=int, required=True, help="The database ID of the target event.")
+@click.option("--output", default="revenue_report.pdf", help="Output PDF file path (default: revenue_report.pdf).")
 def report_revenue(event_id, output):
-    """Generate PDF report of revenue for an event."""
+    """Generate a PDF breakdown of ticket revenue and sales per ticket tier for an event.
+
+    Examples:
+      pgframx report revenue --event-id 1
+      pgframx report revenue --event-id 2 --output exports/summit_revenue.pdf
+    """
     click.echo(f"Generating revenue report for Event #{event_id} at '{output}'...")
     session = get_cli_db_session()
     
@@ -332,9 +413,14 @@ def report_revenue(event_id, output):
         session.close()
 
 @report_group.command(name="events")
-@click.option("--output", default="events_summary_report.pdf", help="Output file path.")
+@click.option("--output", default="events_summary_report.pdf", help="Output PDF file path (default: events_summary_report.pdf).")
 def report_events(output):
-    """Generate PDF summary report of all events."""
+    """Generate an executive PDF summary of all events with attendance and revenue totals.
+
+    Examples:
+      pgframx report events
+      pgframx report events --output exports/monthly_summary.pdf
+    """
     click.echo(f"Generating events summary report at '{output}'...")
     session = get_cli_db_session()
     

{pgframx-0.2.0 → pgframx-0.2.2}/pgframx/scaffolder/html_writer.py

@@ -72,12 +72,12 @@ def write_html_assets(templates_dir: str, dest_dir: str, subtype: str, project_n
     for folder in [templates_dest, base_dest, auth_dest, static_dest]:
         os.makedirs(folder, exist_ok=True)
 
-    # 2. Copy shared layout (layout.html.tpl)
-    layout_src = os.path.join(templates_dir, "_base", "layout.html.tpl")
+    # 2. Copy shared layout (layout.html)
+    layout_src = os.path.join(templates_dir, "_base", "layout.html")
     layout_dest = os.path.join(base_dest, "layout.html")
     
     if os.path.exists(layout_src):
-        # Copy layout.html.tpl directly so that runtime Jinja blocks/functions remain intact
+        # Copy layout.html directly so that runtime Jinja blocks/functions remain intact
         shutil.copy2(layout_src, layout_dest)
     else:
         raise FileNotFoundError(f"Base layout not found at {layout_src}")

pgframx-0.2.2/pgframx/templates/auth/profile.html.tpl

@@ -0,0 +1,43 @@
+{% extends "_base/layout.html" %}
+
+{% block title %}User Profile{% endblock %}
+
+{% block content %}
+<div class="card" style="max-width: 600px; margin: 3rem auto; border-radius: 12px; padding: 2rem;">
+  <h2 style="text-align: center; margin-bottom: 2rem; color: var(--primary);">User Profile</h2>
+  
+  <div style="display: flex; flex-direction: column; gap: 1.5rem;">
+    <div style="display: flex; border-bottom: 1px solid var(--border-color); padding-bottom: 1rem; align-items: center;">
+      <span style="font-weight: 600; width: 150px; color: var(--text-color);">Full Name:</span>
+      <span style="color: var(--text-color);">{{ user.name }}</span>
+    </div>
+    
+    <div style="display: flex; border-bottom: 1px solid var(--border-color); padding-bottom: 1rem; align-items: center;">
+      <span style="font-weight: 600; width: 150px; color: var(--text-color);">Email Address:</span>
+      <span style="color: var(--text-color);">{{ user.email }}</span>
+    </div>
+    
+    <div style="display: flex; border-bottom: 1px solid var(--border-color); padding-bottom: 1rem; align-items: center;">
+      <span style="font-weight: 600; width: 150px; color: var(--text-color);">Role / Privileges:</span>
+      <span class="btn btn-secondary" style="padding: 0.25rem 0.75rem; font-size: 0.85rem; pointer-events: none; text-transform: uppercase;">
+        {{ user.role.name if user.role else 'attendee' }}
+      </span>
+    </div>
+
+    {% if user.created_at %}
+    <div style="display: flex; border-bottom: 1px solid var(--border-color); padding-bottom: 1rem; align-items: center;">
+      <span style="font-weight: 600; width: 150px; color: var(--text-color);">Member Since:</span>
+      <span style="color: var(--text-muted);">{{ user.created_at.strftime('%Y-%m-%d') }}</span>
+    </div>
+    {% endif %}
+  </div>
+
+  <div style="margin-top: 2.5rem; display: flex; gap: 1rem; justify-content: center;">
+    {% if user.role and user.role.name in ['admin', 'organizer'] %}
+      <a href="/admin" class="btn btn-primary">Go to Dashboard</a>
+    {% endif %}
+    <a href="/" class="btn btn-secondary">Browse Events</a>
+    <a href="{{ url_for('auth.logout') }}" class="btn btn-secondary" style="background-color: #EF4444; border-color: #EF4444; color: white;">Sign Out</a>
+  </div>
+</div>
+{% endblock %}

{pgframx-0.2.0 → pgframx-0.2.2}/pgframx/templates/auth/register.html.tpl

@@ -9,32 +9,33 @@
   <form action="{{ url_for('auth.register') }}" method="POST">
     <div class="form-group">
       <label class="form-label" for="name">Full Name</label>
-      <input type="text" name="name" id="name" class="form-input" placeholder="e.g. John Doe" required>
+      <input type="text" name="name" id="name" class="form-input" placeholder="John Doe" required>
     </div>
-    
-    <div class="form-group">
+
+    <div class="form-group" style="margin-top: 1rem;">
       <label class="form-label" for="email">Email Address</label>
       <input type="email" name="email" id="email" class="form-input" placeholder="you@example.com" required>
     </div>
     
-    <div class="form-group">
+    <div class="form-group" style="margin-top: 1rem;">
       <label class="form-label" for="password">Password</label>
       <input type="password" name="password" id="password" class="form-input" placeholder="••••••••" required>
     </div>
-    
-    <div class="form-group">
-      <label class="form-label" for="role">Register As</label>
-      <select name="role" id="role" class="form-input">
-        <option value="attendee">Attendee</option>
-        <option value="organizer">Organizer / Planner</option>
+
+    <div class="form-group" style="margin-top: 1rem;">
+      <label class="form-label" for="role">Account Type</label>
+      <select name="role" id="role" class="form-input" style="background-color: var(--card-bg); color: var(--text-color);">
+        <option value="attendee">Attendee (Browse & Register for Events)</option>
+        <option value="organizer">Organizer (Create & Manage Events)</option>
+        <option value="admin">Administrator (Full Control)</option>
       </select>
     </div>
     
-    <button type="submit" class="btn btn-primary" style="width: 100%; margin-top: 1.5rem;">Register Account</button>
+    <button type="submit" class="btn btn-primary" style="width: 100%; margin-top: 2rem;">Register</button>
   </form>
   
   <p style="text-align: center; margin-top: 1.5rem; font-size: 0.9rem; color: var(--text-muted);">
-    Already registered? <a href="{{ url_for('auth.login') }}" style="color: var(--primary); font-weight: 500;">Login here</a>
+    Already have an account? <a href="{{ url_for('auth.login') }}" style="color: var(--primary); font-weight: 500;">Sign in here</a>
   </p>
 </div>
 {% endblock %}

pgframx-0.2.2/pgframx/templates/concert/models.py.tpl

@@ -0,0 +1,19 @@
+class Artist(Base):
+    __tablename__ = "artists"
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String(100), nullable=False)
+    genre = Column(String(50))
+
+class Venue(Base):
+    __tablename__ = "venues"
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String(100), nullable=False)
+    capacity = Column(Integer)
+
+class Seat(Base):
+    __tablename__ = "seats"
+    id = Column(Integer, primary_key=True, index=True)
+    event_id = Column(Integer, ForeignKey("events.id"))
+    row = Column(String(10))
+    number = Column(Integer)
+    is_reserved = Column(Boolean, default=False)

{pgframx-0.2.0 → pgframx-0.2.2}/pgframx/templates/conference/models.py.tpl

@@ -1,30 +1,24 @@
 class Speaker(Base):
     __tablename__ = "speakers"
     id = Column(Integer, primary_key=True, index=True)
-    event_id = Column(Integer, ForeignKey("events.id"))
     name = Column(String(100), nullable=False)
     bio = Column(String(500))
-    avatar_url = Column(String(255))
-    company = Column(String(100))
-
+    avatar_url = Column(String(200))
 
 class Session(Base):
     __tablename__ = "sessions"
     id = Column(Integer, primary_key=True, index=True)
     event_id = Column(Integer, ForeignKey("events.id"))
     title = Column(String(150), nullable=False)
-    description = Column(Text)
-    speaker_id = Column(Integer, ForeignKey("speakers.id"), nullable=True)
+    speaker_id = Column(Integer, ForeignKey("speakers.id"))
     start_time = Column(DateTime)
     end_time = Column(DateTime)
     hall = Column(String(50))
 
-
 class Sponsor(Base):
     __tablename__ = "sponsors"
     id = Column(Integer, primary_key=True, index=True)
-    event_id = Column(Integer, ForeignKey("events.id"))
     name = Column(String(100), nullable=False)
-    tier = Column(String(50))  # Gold | Silver | Bronze
-    logo_url = Column(String(255))
-    website = Column(String(255))
+    tier = Column(String(50)) # Gold, Silver, Bronze
+    logo_url = Column(String(200))
+    event_id = Column(Integer, ForeignKey("events.id"))

pgframx-0.2.2/pgframx/templates/hackathon/models.py.tpl

@@ -0,0 +1,17 @@
+class Team(Base):
+    __tablename__ = "teams"
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String(100), nullable=False)
+    event_id = Column(Integer, ForeignKey("events.id"))
+
+class Project(Base):
+    __tablename__ = "projects"
+    id = Column(Integer, primary_key=True, index=True)
+    title = Column(String(150), nullable=False)
+    team_id = Column(Integer, ForeignKey("teams.id"))
+    repo_url = Column(String(200))
+
+class Judge(Base):
+    __tablename__ = "judges"
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String(100), nullable=False)

pgframx-0.2.2/pgframx/templates/social/models.py.tpl

@@ -0,0 +1,20 @@
+class Guest(Base):
+    __tablename__ = "guests"
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String(100), nullable=False)
+    event_id = Column(Integer, ForeignKey("events.id"))
+
+class RSVP(Base):
+    __tablename__ = "rsvps"
+    id = Column(Integer, primary_key=True, index=True)
+    guest_id = Column(Integer, ForeignKey("guests.id"))
+    is_attending = Column(Boolean, default=True)
+    plus_ones = Column(Integer, default=0)
+    dietary_restrictions = Column(String(200))
+
+class Wish(Base):
+    __tablename__ = "wishes"
+    id = Column(Integer, primary_key=True, index=True)
+    event_id = Column(Integer, ForeignKey("events.id"))
+    guest_name = Column(String(100))
+    message = Column(Text)

pgframx-0.2.2/pgframx/templates/sports/models.py.tpl

@@ -0,0 +1,22 @@
+class Team(Base):
+    __tablename__ = "teams"
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String(100), nullable=False)
+
+class Match(Base):
+    __tablename__ = "matches"
+    id = Column(Integer, primary_key=True, index=True)
+    event_id = Column(Integer, ForeignKey("events.id"))
+    team_a_id = Column(Integer, ForeignKey("teams.id"))
+    team_b_id = Column(Integer, ForeignKey("teams.id"))
+    score_a = Column(Integer, default=0)
+    score_b = Column(Integer, default=0)
+
+class Standing(Base):
+    __tablename__ = "standings"
+    id = Column(Integer, primary_key=True, index=True)
+    team_id = Column(Integer, ForeignKey("teams.id"))
+    played = Column(Integer, default=0)
+    won = Column(Integer, default=0)
+    lost = Column(Integer, default=0)
+    points = Column(Integer, default=0)

{pgframx-0.2.0 → pgframx-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pgframx"
-version = "0.2.0"
+version = "0.2.2"
 description = "Flask-based event management orchestration framework with scaffold generator"
 authors = [{ name = "pgwiz", email = "peter@wiptech.co.ke" }]
 readme = "README.md"

pgframx-0.2.0/pgframx/templates/_base/models.py.tpl

@@ -1,40 +0,0 @@
-from datetime import datetime
-from sqlalchemy import Column, Integer, String, Text, Float, DateTime, ForeignKey, Boolean, JSON
-from sqlalchemy.orm import relationship
-
-from pgframx.db import Base
-
-class Event(Base):
-    __tablename__ = "events"
-    id = Column(Integer, primary_key=True, index=True)
-    title = Column(String(150), nullable=False)
-    description = Column(Text)
-    date = Column(DateTime, nullable=False)
-    location = Column(String(200))
-    category = Column(String(50))
-    ticket_price = Column(Float, default=0.0)
-    capacity = Column(Integer)
-    organizer_id = Column(Integer, ForeignKey("users.id"))
-    created_at = Column(DateTime, default=datetime.utcnow)
-    
-    attendees = relationship("Attendee", back_populates="event", cascade="all, delete-orphan")
-
-
-class Attendee(Base):
-    __tablename__ = "attendees"
-    id = Column(Integer, primary_key=True, index=True)
-    user_id = Column(Integer, ForeignKey("users.id"))
-    event_id = Column(Integer, ForeignKey("events.id"))
-    ticket_type = Column(String(50), default="general")
-    registered_at = Column(DateTime, default=datetime.utcnow)
-    
-    event = relationship("Event", back_populates="attendees")
-
-
-class AuditLog(Base):
-    __tablename__ = "audit_log"
-    id = Column(Integer, primary_key=True, index=True)
-    action = Column(String(100))
-    user_id = Column(Integer, ForeignKey("users.id"), nullable=True)
-    payload = Column(JSON)
-    timestamp = Column(DateTime, default=datetime.utcnow)