richforms 0.3.0__tar.gz

richforms-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --dev
+      - run: uv run ruff format --check .
+      - run: uv run ruff check .
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --dev
+      - run: uv run ty check --output-format github .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --dev
+      - run: uv run pytest -q

richforms-0.3.0/.github/workflows/docs.yml

@@ -0,0 +1,33 @@
+name: Docs Publish
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/configure-pages@v5
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --dev
+      - run: uv run zensical build --clean
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - id: deployment
+        uses: actions/deploy-pages@v4

richforms-0.3.0/.github/workflows/publish.yml

@@ -0,0 +1,71 @@
+name: PyPI Publish
+
+on:
+  repository_dispatch:
+    types: [pypi-release]
+
+permissions:
+  contents: read
+
+jobs:
+  pypi-release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pypi-${{ github.event.client_payload.tag_name }}
+      cancel-in-progress: true
+    permissions:
+      id-token: write # Generate OIDC token for attestations
+      attestations: write # Attest the build provenance
+    environment:
+      name: pypi
+      url: https://pypi.org/p/richforms
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
+        with:
+          egress-policy: audit
+      -
+        name: Echo Build Dispatch
+        run: |
+          echo "PyPI Release Triggered"
+          echo "Event Payload: ${{ toJson(github.event.client_payload) }}"
+      -
+        name: Checkout Code
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+        with:
+          ref: ${{ github.event.client_payload.tag_name }}
+      -
+        name: Install uv
+        uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
+        with:
+          enable-cache: false
+      -
+        name: Set up Python
+        run: uv python install 3.13
+      -
+        name: Build release distributions
+        run: uv build
+      -
+        name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
+        with:
+          attestations: true
+          packages-dir: dist/
+          verbose: true
+          print-hash: true
+      -
+        name: Attestations for PYPI Wheel
+        uses: actions/attest-build-provenance@e8998f949152b193b063cb0ec769d69d929409be # v2.4.0
+        with:
+          subject-path: |
+            dist/*.whl
+          subject-name: richforms-wheel
+          show-summary: true
+      -
+        name: Attestations for PYPI Source
+        uses: actions/attest-build-provenance@e8998f949152b193b063cb0ec769d69d929409be # v2.4.0
+        with:
+          subject-path: |
+            dist/*.tar.gz
+          subject-name: richforms-source
+          show-summary: true

richforms-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release Automation
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - id: release
+        uses: googleapis/release-please-action@v4.4.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config-file: .release-please-config.json
+          manifest-file: .release-please-manifest.json
+      - name: Dispatch PYPI Release
+        if: ${{ steps.release.outputs.release_created }}
+        uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 # v4.0.1
+        with:
+          repository: shinybrar/richforms
+          event-type: pypi-release
+          token: ${{ secrets.GITHUB_TOKEN }}
+          client-payload: |-
+            {
+              "releases_created": "${{ steps.release.outputs.releases_created }}",
+              "tag_name": "${{ steps.release.outputs.tag_name }}",
+              "sha": "${{ steps.release.outputs.sha }}"
+            }

richforms-0.3.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+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
+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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

richforms-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.1
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+  - repo: local
+    hooks:
+      - id: ty-check
+        name: ty-check
+        entry: uv run ty check .
+        language: system
+        pass_filenames: false
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

richforms-0.3.0/.python-version

@@ -0,0 +1 @@
+3.13

richforms-0.3.0/.release-please-config.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "packages": {
+    ".": {
+      "changelog-path": "CHANGELOG.md",
+      "extra-files": [
+        {
+          "jsonpath": "$.package[?(@.name.value=='richforms')].version",
+          "path": "uv.lock",
+          "type": "toml"
+        }
+      ],
+      "include-component-in-tag": false,
+      "package-name": "richforms",
+      "release-type": "python"
+    }
+  }
+}

richforms-0.3.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.3.0"
+}

richforms-0.3.0/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+## [0.3.0](https://github.com/shinybrar/richforms/compare/v0.2.1...v0.3.0) (2026-02-20)
+
+
+### Features
+
+* **release:** added automation for releasing richforms ([594b5d7](https://github.com/shinybrar/richforms/commit/594b5d7db2cea59df513e78d286b73fbe5bd1c21))
+* **richforms:** initial implementation ([833258f](https://github.com/shinybrar/richforms/commit/833258fa5134ec6dad58bed6749bf01c92eb5088))
+
+
+### Bug Fixes
+
+* **actions:** removed release please action ([7a5bba7](https://github.com/shinybrar/richforms/commit/7a5bba76198c1bc4ac409979adfb542a3f574779))
+* **ci:** actions ([573c432](https://github.com/shinybrar/richforms/commit/573c43243dfd44418e1688576d12be1d6b6b7da5))
+* **ci:** files ([3948703](https://github.com/shinybrar/richforms/commit/394870370abc37813a8d1e546e049a2c48604ced))
+* **ci:** fixed release-please action ([f85b696](https://github.com/shinybrar/richforms/commit/f85b696e51155fc607b77882a428a18d2be09bb6))
+* **ci:** release action ([f9ad040](https://github.com/shinybrar/richforms/commit/f9ad040edab39d030c798de1813b199813e8e895))
+* **deps:** removed click as a dep since it comes from typer ([c5b7fce](https://github.com/shinybrar/richforms/commit/c5b7fce9fb534eb5e8dd4e782f4900571df76864))
+* **deps:** removed library from deps ([dacf997](https://github.com/shinybrar/richforms/commit/dacf997d6b8479307aec0bcc77f059e860f6d382))
+* **package:** deps ([60f15ed](https://github.com/shinybrar/richforms/commit/60f15edb3175783f813218e2a505691ec5bf8289))
+* **pypi:** release ([a8d2dc8](https://github.com/shinybrar/richforms/commit/a8d2dc83f84fe4410cd118c520478bdf9846809e))
+* **release-please:** action ([a6c3e01](https://github.com/shinybrar/richforms/commit/a6c3e01f75db4d021d8b854b09498040cac5d4db))
+* **release:** automations ([488de1b](https://github.com/shinybrar/richforms/commit/488de1b2835e86d26e9a0895ae348506bc5bda6b))
+* **render:** styling ([cc50f1b](https://github.com/shinybrar/richforms/commit/cc50f1b0029854e1a5b64ed0008f12def670a947))
+
+
+### Documentation
+
+* **zensical:** overhaul ([1d0f30c](https://github.com/shinybrar/richforms/commit/1d0f30c8630457b105630fd31d9293a6b5aed42f))
+
+## [0.2.1](https://github.com/shinybrar/richforms/compare/richforms-v0.2.0...richforms-v0.2.1) (2026-02-20)
+
+
+### Documentation
+
+* **zensical:** overhaul ([1d0f30c](https://github.com/shinybrar/richforms/commit/1d0f30c8630457b105630fd31d9293a6b5aed42f))
+
+## [0.2.0](https://github.com/shinybrar/richforms/compare/richforms-v0.1.0...richforms-v0.2.0) (2026-02-19)
+
+
+### Features
+
+* **richforms:** initial implementation ([833258f](https://github.com/shinybrar/richforms/commit/833258fa5134ec6dad58bed6749bf01c92eb5088))
+
+
+### Bug Fixes
+
+* **ci:** fixed release-please action ([f85b696](https://github.com/shinybrar/richforms/commit/f85b696e51155fc607b77882a428a18d2be09bb6))
+* **deps:** removed library from deps ([dacf997](https://github.com/shinybrar/richforms/commit/dacf997d6b8479307aec0bcc77f059e860f6d382))
+* **render:** styling ([cc50f1b](https://github.com/shinybrar/richforms/commit/cc50f1b0029854e1a5b64ed0008f12def670a947))
+
+## Changelog
+
+All notable changes to this project will be documented in this file.

richforms-0.3.0/LICENSE

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

richforms-0.3.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: richforms
+Version: 0.3.0
+Summary: Rich terminal forms generated from Pydantic models.
+Author-email: Shiny Brar <shiny.brar@nrc-cnrc.gc.ca>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=14.0
+Requires-Dist: typer>=0.20
+Description-Content-Type: text/markdown
+
+# richforms
+
+`richforms` turns Pydantic models into rich interactive terminal forms.
+
+## Installation
+
+You can add `richforms` to your project with `uv`.
+
+```bash
+uv add richforms
+```
+
+## Usage
+
+You can start from Python in-process or from the bundled CLI.
+
+### Python API
+
+```python
+from richforms.example.model import Metadata
+from richforms import fill
+
+
+metadata = fill(Metadata)
+print(metadata.model_dump_json(indent=2))
+```
+
+### CLI
+
+```bash
+richforms fill richforms.example.model:Metadata --output project-metadata.json
+```
+
+### Integrations
+
+You can integrate `richforms` directly into Click and Typer option callbacks.
+
+```python
+import typer
+
+from richforms.integrations.typer import form_callback
+from richforms.example.model import Metadata
+
+app = typer.Typer()
+
+
+@app.command()
+def release(
+    metadata: Metadata = typer.Option(
+        None,
+        callback=form_callback(Metadata),
+    ),
+) -> None:
+    print(metadata.model_dump())
+```
+
+## Documentation
+
+For more information, see the [documentation](https://shinybrar.github.io/richforms/).

richforms-0.3.0/README.md

@@ -0,0 +1,59 @@
+# richforms
+
+`richforms` turns Pydantic models into rich interactive terminal forms.
+
+## Installation
+
+You can add `richforms` to your project with `uv`.
+
+```bash
+uv add richforms
+```
+
+## Usage
+
+You can start from Python in-process or from the bundled CLI.
+
+### Python API
+
+```python
+from richforms.example.model import Metadata
+from richforms import fill
+
+
+metadata = fill(Metadata)
+print(metadata.model_dump_json(indent=2))
+```
+
+### CLI
+
+```bash
+richforms fill richforms.example.model:Metadata --output project-metadata.json
+```
+
+### Integrations
+
+You can integrate `richforms` directly into Click and Typer option callbacks.
+
+```python
+import typer
+
+from richforms.integrations.typer import form_callback
+from richforms.example.model import Metadata
+
+app = typer.Typer()
+
+
+@app.command()
+def release(
+    metadata: Metadata = typer.Option(
+        None,
+        callback=form_callback(Metadata),
+    ),
+) -> None:
+    print(metadata.model_dump())
+```
+
+## Documentation
+
+For more information, see the [documentation](https://shinybrar.github.io/richforms/).