pdfrender 0.1.0__tar.gz

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

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # setuptools-scm needs the full history (incl. tags) to compute a version
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[development]"
+
+      - name: Run tests
+        run: pytest
+
+  lint-and-docs:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # setuptools-scm needs the full history (incl. tags) to compute a version
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[development,docs]"
+
+      - name: isort --check-only
+        run: isort --check-only --diff pdf_render tests extras/examples
+
+      - name: ruff check
+        run: ruff check pdf_render tests extras/examples
+
+      - name: ruff format --check
+        run: ruff format --check pdf_render tests extras/examples
+
+      - name: Build docs (check only, no deploy)
+        run: mkdocs build -f extras/docs/mkdocs.yml

pdfrender-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,68 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish-package:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pdfrender
+    permissions:
+      id-token: write # for PyPI trusted publishing (OIDC) - no stored token needed
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # setuptools-scm needs the full history (incl. tags) to compute a version
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tool
+        run: python -m pip install --upgrade pip build
+
+      - name: Build the distribution package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0
+
+  deploy-docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write # for deploying to GitHub Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[docs]"
+
+      - name: Build docs
+        run: mkdocs build -f extras/docs/mkdocs.yml
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: extras/docs/site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pdfrender-0.1.0/.gitignore

@@ -0,0 +1,257 @@
+/init.sh
+*.tmp
+.idea
+build/
+dist/
+sdist/
+/tests/fixtures/output/
+/extras/docs/site/
+/extras/examples/output/
+
+# Source: https://github.com/github/gitignor
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+develop-eggs/
+downloads/
+eggs/
+.eggs/
+lib/
+bin/
+lib64/
+parts/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+extras/docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/
+
+
+## MacOS
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+## Windows
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+## Linux
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+## Vim
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+/documentation_todos.md

pdfrender-0.1.0/LICENSE

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

pdfrender-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: pdfrender
+Version: 0.1.0
+Summary: Using DB models and Jinja2 to generate templated PDF documents
+Author-email: Cam Ratchford <camratchford@gmail.com>
+Project-URL: Homepage, https://github.com/camratchford/pdfrender
+Project-URL: Source, https://github.com/camratchford/pdfrender
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: byoconfig
+Requires-Dist: typer
+Requires-Dist: jinja2
+Requires-Dist: click
+Requires-Dist: textual
+Requires-Dist: pyyaml
+Requires-Dist: sqlmodel
+Requires-Dist: pydantic
+Requires-Dist: markdown
+Requires-Dist: pymdown-extensions
+Requires-Dist: pygments
+Requires-Dist: weasyprint
+Provides-Extra: development
+Requires-Dist: pytest; extra == "development"
+Requires-Dist: pytest-cov; extra == "development"
+Requires-Dist: isort; extra == "development"
+Requires-Dist: ruff; extra == "development"
+Requires-Dist: build; extra == "development"
+Provides-Extra: docs
+Requires-Dist: mkdocs~=1.6; extra == "docs"
+Requires-Dist: mkdocs-autorefs~=1.4; extra == "docs"
+Requires-Dist: mkdocs-get-deps~=0.2.2; extra == "docs"
+Requires-Dist: mkdocs-material~=9.7; extra == "docs"
+Requires-Dist: mkdocs-material-extensions~=1.3; extra == "docs"
+Requires-Dist: mkdocstrings~=1.0; extra == "docs"
+Requires-Dist: mkdocstrings-python~=2.0; extra == "docs"
+Dynamic: license-file
+
+# pdfrender
+
+A database relationship and template-driven Markdown to PDF toolkit.
+
+Bring your own SQLAlchemy/SQLModel models, YAML data, and Jinja2 templates.
+
+
+- Type-aware model importing DB data from YAML. Supports nested instance data for dynamically assigning relationships.
+- Facilities to perform DB queries inside the Jinja2 template context
+- Custom Jinja2 Environment object:
+   - Pre-processes templates to support typed variables, allowing template authors to specify variable types 
+     using PEP 484 annotation syntax.
+   - Stores undefined variables, allowing for run-time user variable prompts
+- Dynamically composed Textual CLI form, to capture run-time user variable inputs 
+
+## Documentation
+
+Published at https://camratchford.github.io/pdfrender/ (deployed on release,
+see below). To view locally instead:
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve -f extras/docs/mkdocs.yml
+```
+
+Then open http://127.0.0.1:8000.
+
+## Releasing
+
+The package version comes from git tags via `setuptools-scm` - there's
+nothing to bump by hand in `pyproject.toml`. To cut a release:
+
+```bash
+git tag v0.1.0
+git push --tags
+```
+
+Pushing a `v*` tag triggers `.github/workflows/release.yml`, which builds
+the package and publishes it to PyPI (via
+[trusted publishing](https://docs.pypi.org/trusted-publishers/), no stored
+token needed), and deploys `extras/docs` to GitHub Pages.
+
+One-time setup this repo needs before that works:
+
+- **PyPI**: add a trusted publisher on the
+  [pdfrender PyPI project](https://pypi.org/manage/project/pdfrender/publishing/)
+  pointing at this repo and the `release.yml` workflow.
+- **GitHub Pages**: under Settings -> Pages, set Source to "GitHub Actions".

pdfrender-0.1.0/README.md

@@ -0,0 +1,48 @@
+# pdfrender
+
+A database relationship and template-driven Markdown to PDF toolkit.
+
+Bring your own SQLAlchemy/SQLModel models, YAML data, and Jinja2 templates.
+
+
+- Type-aware model importing DB data from YAML. Supports nested instance data for dynamically assigning relationships.
+- Facilities to perform DB queries inside the Jinja2 template context
+- Custom Jinja2 Environment object:
+   - Pre-processes templates to support typed variables, allowing template authors to specify variable types 
+     using PEP 484 annotation syntax.
+   - Stores undefined variables, allowing for run-time user variable prompts
+- Dynamically composed Textual CLI form, to capture run-time user variable inputs 
+
+## Documentation
+
+Published at https://camratchford.github.io/pdfrender/ (deployed on release,
+see below). To view locally instead:
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve -f extras/docs/mkdocs.yml
+```
+
+Then open http://127.0.0.1:8000.
+
+## Releasing
+
+The package version comes from git tags via `setuptools-scm` - there's
+nothing to bump by hand in `pyproject.toml`. To cut a release:
+
+```bash
+git tag v0.1.0
+git push --tags
+```
+
+Pushing a `v*` tag triggers `.github/workflows/release.yml`, which builds
+the package and publishes it to PyPI (via
+[trusted publishing](https://docs.pypi.org/trusted-publishers/), no stored
+token needed), and deploys `extras/docs` to GitHub Pages.
+
+One-time setup this repo needs before that works:
+
+- **PyPI**: add a trusted publisher on the
+  [pdfrender PyPI project](https://pypi.org/manage/project/pdfrender/publishing/)
+  pointing at this repo and the `release.yml` workflow.
+- **GitHub Pages**: under Settings -> Pages, set Source to "GitHub Actions".

pdfrender-0.1.0/extras/docs/docs/api/data.md

@@ -0,0 +1,7 @@
+# pdf_render.data
+
+::: pdf_render.data.DataImporter
+
+::: pdf_render.data.DBAccessor
+
+::: pdf_render.data.ModelType

pdfrender-0.1.0/extras/docs/docs/api/markdown.md

@@ -0,0 +1,15 @@
+# pdf_render.md
+
+::: pdf_render.md.create_markdown_renderer
+
+## Extensions
+
+::: pdf_render.md.extensions.FlexColumnsExtension
+
+::: pdf_render.md.extensions.FlexWrapExtension
+
+::: pdf_render.md.extensions.MutedTextExtension
+
+::: pdf_render.md.extensions.NerdfontGlyphExtension
+
+::: pdf_render.md.extensions.PageBreakExtension

pdfrender-0.1.0/extras/docs/docs/api/pdf.md

@@ -0,0 +1,7 @@
+# pdf_render.pdf
+
+::: pdf_render.pdf.render_pdf
+
+::: pdf_render.pdf.PDFOptions
+
+::: pdf_render.pdf.PDFMetadata

pdfrender-0.1.0/extras/docs/docs/api/templates.md

@@ -0,0 +1,15 @@
+# pdf_render.templates
+
+::: pdf_render.templates.new_template_environment
+
+::: pdf_render.templates.TypedVariableEnvironment
+
+## Filters
+
+::: pdf_render.templates.filters.jinja_filter_month_year_fmt
+
+::: pdf_render.templates.filters.jinja_filter_phone_num_fmt
+
+::: pdf_render.templates.filters.jinja_filter_get_list_item_by_attr
+
+::: pdf_render.templates.filters.jinja_filter_with_item_attr_first

pdfrender-0.1.0/extras/docs/docs/api/user-input.md

@@ -0,0 +1,3 @@
+# pdf_render.user_input
+
+::: pdf_render.user_input.prompt_for_undefined_variables