reportlab-json-renderer 0.1.0__tar.gz

reportlab_json_renderer-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install ruff
+      - run: ruff check .
+      - run: ruff format --check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest --tb=short -q
+      - run: pytest --cov --cov-report=term-missing --cov-fail-under=90
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

reportlab_json_renderer-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,61 @@
+# Publishes reportlab-json-renderer to PyPI whenever a version tag (v*) is pushed,
+# or when triggered manually via the GitHub Actions UI.
+#
+# Uses PyPI Trusted Publishing (OIDC) — no API token secret is required.
+# One-time PyPI setup: see README.md § "Publishing to PyPI".
+
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"           # e.g. v0.1.0, v1.2.3
+  workflow_dispatch:   # allow manual runs from the Actions tab
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+
+    # Required for PyPI Trusted Publishing (OIDC)
+    environment:
+      name: pypi
+      url: https://pypi.org/p/reportlab-json-renderer
+
+    permissions:
+      id-token: write   # OIDC token — this replaces the need for an API secret
+
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

reportlab_json_renderer-0.1.0/.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# pytest / coverage
+.pytest_cache/
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+
+# Ruff
+.ruff_cache/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Generated PDFs (don't commit test output)
+*.pdf
+!tests/fixtures/*.pdf

reportlab_json_renderer-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  # ── Linting & formatting ────────────────────────────────────────────
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.8
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  # ── Tests & coverage ────────────────────────────────────────────────
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: pytest
+        language: system
+        pass_filenames: false
+        always_run: true
+
+      - id: coverage
+        name: coverage check
+        entry: pytest --cov --cov-report=term-missing --cov-fail-under=90
+        language: system
+        pass_filenames: false
+        always_run: true

reportlab_json_renderer-0.1.0/AGENTS.md

@@ -0,0 +1,74 @@
+# Agent Instructions
+
+This file defines how coding agents must work in this repository.
+Make sure that we are building python3 library which other python projects can easily extend and use as per their requirement. 
+
+## Working Principles
+
+- Treat `pdf-generator.md` as the source of truth for library behavior.
+- Do not re-open locked decisions unless the user explicitly asks to change them.
+- Keep implementation choices boring, stable, and easy to maintain.
+- Prefer clear bounded contexts over clever shared abstractions.
+- Make small, reviewable changes.
+- Preserve user changes. Do not revert unrelated work.
+
+## Coding Standard
+
+- Constants must be contained in a single file per package or bounded context.
+- Each Python file must do exactly one domain task.
+- Folders must be logically grouped by responsibility.
+- Always prefer the most stable, reputed, security-aware third-party dependencies.
+- Each function must do one granular task, such as:
+    - merging data
+    - fetching data
+    - validating data
+    - transforming data
+    - processing data
+    - mutating data
+- Keep functions around 50 lines or less.
+- Any function with control flow must have a test case.
+- The pre-commit hook must run:
+    - linting
+    - tests
+    - coverage
+
+## Dependency Policy
+
+Before adding a dependency:
+
+1. Prefer platform or framework built-ins.
+2. Prefer existing project dependencies.
+3. If a new dependency is needed, choose stable, reputed, actively maintained, security-aware npm packages.
+4. Avoid niche packages for small utilities.
+5. Avoid unmaintained packages.
+6. Avoid packages with unnecessary runtime weight.
+
+Security-sensitive areas such as ZIP parsing, markdown rendering, auth, and validation require conservative dependency choices.
+
+
+
+## Git And Change Hygiene
+
+- Check current files before editing.
+- Keep changes scoped to the request.
+- Do not reformat unrelated files.
+- Do not rename or reorganize folders unless required by the task.
+- Do not commit unless the user asks.
+- Do not remove user changes.
+
+## Pre-Commit Requirement
+
+The repository must eventually include a pre-commit hook that runs:
+
+- linting
+- tests
+- coverage
+
+Do not bypass the hook to land changes.
+
+If the project has not been scaffolded yet, preserve this requirement for the initial setup.
+
+## Documentation Rules
+
+- Update this file when coding workflow, repository conventions, or test standards change.
+- Make sure Readme.md clearly explains what problem it solves and how to install, test and run and use the library.

reportlab_json_renderer-0.1.0/CHANGELOG.md

@@ -0,0 +1,81 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — 2026-06-19
+
+### Added
+
+#### Core
+- JSON-driven PDF generation over ReportLab with strict schema validation.
+- `render_pdf` Python API and `pdf-renderer` CLI (`render`, `validate`, `schema`, `templates`).
+- Pydantic-based schema validation with `extra="forbid"` and version compatibility checks.
+- Validation warnings propagated into render results.
+
+#### Block Renderers (19 types)
+- `title` — report title with entity, subtitle, and right-aligned text.
+- `section_header` — numbered or unnumbered section headings.
+- `paragraph` — body, bold, and caption styles with markup escaping.
+- `rich_text` — multi-run inline formatting with tone colours.
+- `kpi_grid` — key performance indicator cards in a responsive grid.
+- `callout` — single callout box with tone-based styling.
+- `callout_group` — grouped callouts with optional title.
+- `table` — column-keyed data table with striped and plain styles.
+- `matrix_table` — row/column matrix for comparison tables.
+- `insight_list` — titled insight items with body text.
+- `recommendations` — action items with priority, owner, and impact.
+- `summary_box` — highlighted summary with tone-based border.
+- `image` — local image embedding with path traversal protection.
+- `chart` — bar, pie, and grouped-bar charts via matplotlib.
+- `two_column` — side-by-side layout with configurable widths.
+- `spacer` — vertical spacing.
+- `page_break` — explicit page break.
+- `divider` — horizontal rule with tone and thickness.
+- `badge` — inline label badge with tone colour.
+
+#### Templates
+- `analytics_report_v1` — default analytics report layout.
+- `business_report_v1` — business-focused report layout.
+- `compact_report_v1` — condensed single-page layout.
+- `invoice_v1` — invoice document layout.
+- `proposal_v1` — multi-page proposal layout.
+
+#### Themes
+- `green` — green-accented professional theme.
+- `neutral` — grey neutral theme.
+- `dark` — dark background theme.
+
+#### Safety And Validation
+- Strict schema inputs with `extra="forbid"` where appropriate.
+- Schema version compatibility enforcement.
+- Image path traversal protection and safe-path validation.
+- Resource limits for large payloads, images, and oversized tables/charts.
+- Temporary file cleanup for base64 image handling.
+- User-controlled text escaping before ReportLab markup rendering.
+- Fail-closed block rendering by default.
+- Template `allowed_blocks` enforcement.
+
+#### Determinism
+- Reduced non-deterministic PDF output.
+- Parsed-PDF verification with pypdf (page count, text extraction).
+- Idempotent rendering (same spec → identical bytes).
+
+#### Testing
+- Comprehensive unit tests for all 19 block renderers.
+- Golden PDF tests for all 6 templates.
+- Edge-case fixtures (empty blocks, minimal fields, all block types, page sizes).
+- Theme coverage tests (green, neutral, dark).
+- Schema validation tests.
+- CLI tests.
+- Chart, colour, image, text, and unit utility tests.
+
+#### Packaging
+- MIT license.
+- PyPI-ready metadata with classifiers and project URLs.
+- Hatchling build system.
+- Ruff linting and formatting.
+- Pre-commit hook configuration.
+- pytest with coverage (90% threshold).

reportlab_json_renderer-0.1.0/LICENSE

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