propongo2 0.1.1__tar.gz

propongo2-0.1.1/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: propongo2
+Version: 0.1.1
+Summary: A local proposal generator for conservation and natural resource projects
+Author: VR Conservation
+License: MIT
+Project-URL: Repository, https://github.com/VRConservation/propongo2
+Keywords: proposal,generator,conservation,budget,scope
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: flask>=3.0
+Requires-Dist: weasyprint>=60.0
+Requires-Dist: markdown>=3.5
+Requires-Dist: python-docx>=1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: bump2version>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+
+# Propongo 2
+
+A local proposal generator for conservation and natural resource projects. Create professional proposals with scope of work, budgets, qualifications, timelines, and export to PDF or HTML.
+
+## Features
+
+- **Scope of Work** - Define project summary, tasks, and deliverables
+- **Budget** - Line-item budgeting with cost/unit calculations and totals
+- **Qualifications** - Document team background and relevant experience
+- **Timeline** - Set lead times and durations per task with Gantt chart visualization
+- **Preview** - View the complete proposal before exporting
+- **PDF Export** - Clean, professional PDF output via WeasyPrint
+- **HTML Export** - Standalone HTML file with embedded styles
+- **Snippet Library** - Reusable markdown components for organization descriptions, deliverable templates, and custom content
+- **Save/Load** - Proposals stored as JSON files on disk, no database required
+
+## Quick Start
+
+### Install from PyPI
+
+```bash
+pip install propongo2
+```
+
+### Run
+
+```bash
+propongo2
+```
+
+Opens at [http://localhost:5000](http://localhost:5000)
+
+### Install from source
+
+```bash
+git clone https://github.com/VRConservation/propongo2.git
+cd propongo2
+pip install -e .
+propongo2
+```
+
+### Development setup
+
+```bash
+git clone https://github.com/VRConservation/propongo2.git
+cd propongo2
+pip install -e ".[dev]"
+python run.py
+```
+
+## Usage
+
+### Creating a Proposal
+
+1. Click **New Proposal** from the dashboard
+2. Enter a title and optional client name in the header
+3. Work through each tab:
+
+   **Scope** - Add a project summary, then create tasks/deliverables with descriptions
+
+   **Budget** - Select a task, enter line items with cost per unit and quantities. Totals calculate automatically.
+
+   **Qualifications** - Describe your organization's background and why you're qualified for this project
+
+   **Timeline** - Set project start date, configure lead times and durations per task, then view the Gantt chart
+
+   **Preview** - Review the complete proposal before exporting
+
+### Using Snippets
+
+Click the sidebar icon (☰) to open the snippet library:
+
+- **Organization** - Pre-written organization descriptions
+- **Deliverables** - Templates for common deliverable types (surveys, assessments, plans)
+- **Custom** - Create and save your own reusable snippets
+
+Click a snippet to insert it at the cursor position in any text field.
+
+### Exporting
+
+- **PDF** - Click "Export PDF" to generate a clean, professional PDF document
+- **HTML** - Click "Export HTML" to download a standalone HTML file
+- **Print** - Use Ctrl+P / Cmd+P in the Preview tab for browser printing
+
+### Managing Proposals
+
+- Proposals auto-save as you work
+- Click "Proposals" in the header to see all saved proposals
+- Create, edit, or delete proposals from the dashboard
+
+## Updating
+
+### From PyPI
+
+```bash
+pip install --upgrade propongo2
+```
+
+### From source
+
+```bash
+cd propongo2
+git pull
+pip install -e .
+```
+
+## Development
+
+### Run tests
+
+```bash
+pytest
+```
+
+### Bump version
+
+```bash
+bump2version patch   # 0.1.0 -> 0.1.1
+bump2version minor   # 0.1.1 -> 0.2.0
+bump2version major   # 0.2.0 -> 1.0.0
+```
+
+### Publish to PyPI
+
+```bash
+python -m build
+twine upload dist/*
+```
+
+## Project Structure
+
+```
+propongo2/
+├── run.py                      # Dev entry point
+├── pyproject.toml              # Package config
+├── requirements.txt            # Dependencies
+├── app/
+│   ├── __init__.py             # Version
+│   ├── main.py                 # Flask app + routes
+│   ├── models.py               # Proposal data model
+│   ├── export.py               # PDF/HTML export
+│   ├── snippets.py             # Snippet management
+│   ├── templates/              # Jinja2 templates
+│   │   ├── base.html           # Layout + HTMX
+│   │   ├── index.html          # Proposal dashboard
+│   │   ├── scope.html          # Scope editor
+│   │   ├── budget.html         # Budget editor
+│   │   ├── qualifications.html # Qualifications editor
+│   │   ├── timeline.html       # Timeline + Gantt
+│   │   ├── preview.html        # Proposal preview
+│   │   └── export_proposal.html# PDF export template
+│   ├── static/
+│   │   ├── css/style.css       # All styles
+│   │   └── js/
+│   │       ├── app.js          # Core JS + HTMX helpers
+│   │       ├── budget.js       # Budget calculations
+│   │       ├── gantt.js        # Gantt chart rendering
+│   │       └── snippets.js     # Snippet panel logic
+│   ├── snippets/               # Stock snippet data
+│   │   ├── organization.json
+│   │   ├── deliverables.json
+│   │   └── custom/             # User-created snippets
+│   └── data/
+│       └── proposals/          # Saved proposals (JSON)
+└── tests/
+    ├── test_main.py
+    └── test_export.py
+```
+
+## Tech Stack
+
+- **Backend:** Python, Flask
+- **Frontend:** HTMX, Jinja2, vanilla CSS/JS
+- **PDF Export:** WeasyPrint
+- **Packaging:** pyproject.toml, setuptools
+
+## License
+
+MIT

propongo2-0.1.1/README.md

@@ -0,0 +1,179 @@
+# Propongo 2
+
+A local proposal generator for conservation and natural resource projects. Create professional proposals with scope of work, budgets, qualifications, timelines, and export to PDF or HTML.
+
+## Features
+
+- **Scope of Work** - Define project summary, tasks, and deliverables
+- **Budget** - Line-item budgeting with cost/unit calculations and totals
+- **Qualifications** - Document team background and relevant experience
+- **Timeline** - Set lead times and durations per task with Gantt chart visualization
+- **Preview** - View the complete proposal before exporting
+- **PDF Export** - Clean, professional PDF output via WeasyPrint
+- **HTML Export** - Standalone HTML file with embedded styles
+- **Snippet Library** - Reusable markdown components for organization descriptions, deliverable templates, and custom content
+- **Save/Load** - Proposals stored as JSON files on disk, no database required
+
+## Quick Start
+
+### Install from PyPI
+
+```bash
+pip install propongo2
+```
+
+### Run
+
+```bash
+propongo2
+```
+
+Opens at [http://localhost:5000](http://localhost:5000)
+
+### Install from source
+
+```bash
+git clone https://github.com/VRConservation/propongo2.git
+cd propongo2
+pip install -e .
+propongo2
+```
+
+### Development setup
+
+```bash
+git clone https://github.com/VRConservation/propongo2.git
+cd propongo2
+pip install -e ".[dev]"
+python run.py
+```
+
+## Usage
+
+### Creating a Proposal
+
+1. Click **New Proposal** from the dashboard
+2. Enter a title and optional client name in the header
+3. Work through each tab:
+
+   **Scope** - Add a project summary, then create tasks/deliverables with descriptions
+
+   **Budget** - Select a task, enter line items with cost per unit and quantities. Totals calculate automatically.
+
+   **Qualifications** - Describe your organization's background and why you're qualified for this project
+
+   **Timeline** - Set project start date, configure lead times and durations per task, then view the Gantt chart
+
+   **Preview** - Review the complete proposal before exporting
+
+### Using Snippets
+
+Click the sidebar icon (☰) to open the snippet library:
+
+- **Organization** - Pre-written organization descriptions
+- **Deliverables** - Templates for common deliverable types (surveys, assessments, plans)
+- **Custom** - Create and save your own reusable snippets
+
+Click a snippet to insert it at the cursor position in any text field.
+
+### Exporting
+
+- **PDF** - Click "Export PDF" to generate a clean, professional PDF document
+- **HTML** - Click "Export HTML" to download a standalone HTML file
+- **Print** - Use Ctrl+P / Cmd+P in the Preview tab for browser printing
+
+### Managing Proposals
+
+- Proposals auto-save as you work
+- Click "Proposals" in the header to see all saved proposals
+- Create, edit, or delete proposals from the dashboard
+
+## Updating
+
+### From PyPI
+
+```bash
+pip install --upgrade propongo2
+```
+
+### From source
+
+```bash
+cd propongo2
+git pull
+pip install -e .
+```
+
+## Development
+
+### Run tests
+
+```bash
+pytest
+```
+
+### Bump version
+
+```bash
+bump2version patch   # 0.1.0 -> 0.1.1
+bump2version minor   # 0.1.1 -> 0.2.0
+bump2version major   # 0.2.0 -> 1.0.0
+```
+
+### Publish to PyPI
+
+```bash
+python -m build
+twine upload dist/*
+```
+
+## Project Structure
+
+```
+propongo2/
+├── run.py                      # Dev entry point
+├── pyproject.toml              # Package config
+├── requirements.txt            # Dependencies
+├── app/
+│   ├── __init__.py             # Version
+│   ├── main.py                 # Flask app + routes
+│   ├── models.py               # Proposal data model
+│   ├── export.py               # PDF/HTML export
+│   ├── snippets.py             # Snippet management
+│   ├── templates/              # Jinja2 templates
+│   │   ├── base.html           # Layout + HTMX
+│   │   ├── index.html          # Proposal dashboard
+│   │   ├── scope.html          # Scope editor
+│   │   ├── budget.html         # Budget editor
+│   │   ├── qualifications.html # Qualifications editor
+│   │   ├── timeline.html       # Timeline + Gantt
+│   │   ├── preview.html        # Proposal preview
+│   │   └── export_proposal.html# PDF export template
+│   ├── static/
+│   │   ├── css/style.css       # All styles
+│   │   └── js/
+│   │       ├── app.js          # Core JS + HTMX helpers
+│   │       ├── budget.js       # Budget calculations
+│   │       ├── gantt.js        # Gantt chart rendering
+│   │       └── snippets.js     # Snippet panel logic
+│   ├── snippets/               # Stock snippet data
+│   │   ├── organization.json
+│   │   ├── deliverables.json
+│   │   └── custom/             # User-created snippets
+│   └── data/
+│       └── proposals/          # Saved proposals (JSON)
+└── tests/
+    ├── test_main.py
+    └── test_export.py
+```
+
+## Tech Stack
+
+- **Backend:** Python, Flask
+- **Frontend:** HTMX, Jinja2, vanilla CSS/JS
+- **PDF Export:** WeasyPrint
+- **Packaging:** pyproject.toml, setuptools
+
+## License
+
+MIT

propongo2-0.1.1/app/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.1"

propongo2-0.1.1/app/export.py

@@ -0,0 +1,104 @@
+import os
+from io import BytesIO
+from weasyprint import HTML
+from flask import Blueprint, render_template, request, send_file, jsonify, Response
+from .models import Proposal
+
+export_bp = Blueprint("export", __name__)
+
+EXPORT_DIR = os.path.join(os.path.dirname(os.path.dirname(__file__)), "data", "exports")
+
+
+def ensure_export_dir():
+    os.makedirs(EXPORT_DIR, exist_ok=True)
+
+
+def _build_export_context(proposal):
+    indirect_percent = getattr(proposal, 'indirect_percent', 0) or 0
+    indirect_amount = proposal.total_budget * (indirect_percent / 100)
+    total_with_indirect = proposal.total_budget + indirect_amount
+
+    tasks_with_timing = []
+    for t in proposal.tasks:
+        tasks_with_timing.append({
+            "id": t.get("id", ""),
+            "name": t.get("name", ""),
+            "description": t.get("description", ""),
+            "lead_entity": t.get("lead_entity", ""),
+            "start_month": t.get("start_month"),
+            "start_year": t.get("start_year"),
+            "duration_months": t.get("duration_months", 1),
+        })
+
+    budget_with_timing = []
+    timings = proposal.budget_item_timings or {}
+    for item in proposal.budget_items:
+        item_id = item.get("id", "")
+        timing = timings.get(item_id, {})
+        budget_with_timing.append({
+            **item,
+            "start_month": timing.get("start_month"),
+            "start_year": timing.get("start_year"),
+            "duration_months": timing.get("duration_months", 1),
+            "task_id": item.get("task_id", ""),
+        })
+
+    return {
+        "proposal": proposal,
+        "tasks": tasks_with_timing,
+        "budget_items": proposal.budget_items,
+        "budget_with_timing": budget_with_timing,
+        "total_budget": proposal.total_budget,
+        "indirect_percent": indirect_percent,
+        "indirect_amount": indirect_amount,
+        "total_with_indirect": total_with_indirect,
+    }
+
+
+@export_bp.route("/export/pdf/<proposal_id>")
+def export_pdf(proposal_id):
+    proposal = Proposal.load(proposal_id)
+    if not proposal:
+        return jsonify({"error": "Proposal not found"}), 404
+
+    ctx = _build_export_context(proposal)
+    html_content = render_template("export_proposal.html", **ctx)
+
+    ensure_export_dir()
+    pdf_path = os.path.join(EXPORT_DIR, f"{proposal_id}.pdf")
+    HTML(string=html_content, base_url=request.host_url).write_pdf(pdf_path)
+
+    return send_file(
+        pdf_path,
+        mimetype="application/pdf",
+        as_attachment=True,
+        download_name=f"{proposal.title or 'proposal'}.pdf",
+    )
+
+
+@export_bp.route("/export/html/<proposal_id>")
+def export_html(proposal_id):
+    proposal = Proposal.load(proposal_id)
+    if not proposal:
+        return jsonify({"error": "Proposal not found"}), 404
+
+    ctx = _build_export_context(proposal)
+    html_content = render_template("export_proposal.html", **ctx)
+
+    return Response(
+        html_content,
+        mimetype="text/html",
+        headers={
+            "Content-Disposition": f"inline; filename={proposal.title or 'proposal'}.html"
+        },
+    )
+
+
+@export_bp.route("/preview/<proposal_id>")
+def preview(proposal_id):
+    proposal = Proposal.load(proposal_id)
+    if not proposal:
+        return jsonify({"error": "Proposal not found"}), 404
+
+    ctx = _build_export_context(proposal)
+    return render_template("export_proposal.html", **ctx)