dash-fn-form 0.0.1__tar.gz

dash_fn_form-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: 🐛 Bug Report
+about: Report a bug
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Bug report
+
+**Bug summary**
+
+<!--A short 1-2 sentences that succinctly describes the bug-->
+
+**Code for reproduction**
+
+<!--A minimum code snippet required to reproduce the bug.
+Please make sure to minimize the number of dependencies required.
+
+```python
+# Paste your code here
+#
+#
+```
+
+**Actual outcome**
+
+<!--The output produced by the above code, which may be a screenshot, console output, etc.-->
+
+**Expected outcome**
+
+<!--A description of the expected outcome from the code snippet-->
+
+**Version Info**
+<!--Please specify your platform and versions of the relevant libraries you are using:-->
+  * Operating system:
+  * Python version:
+  * Package version:
+  * Other libraries:

dash_fn_form-0.0.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: true # default

dash_fn_form-0.0.1/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,29 @@
+---
+name: 📖 Documentation improvement
+about: Report parts of the docs that are wrong or unclear
+labels: documentation, bug
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Problem
+
+<!--
+If you are referencing an existing piece of documentation or example please provide a link.
+
+* I found [...] to be unclear because [...]
+* [...] made me think that [...] when really it should be [...]
+* There is no example showing how to do [...]
+-->
+
+
+### Suggested Improvement
+
+<!--
+If you have an idea to improve the documentation please suggest it here
+
+* This line should be be changed to say [...]
+* Include a paragraph explaining [...]
+* Add a figure showing [...]
+-->

dash_fn_form-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,34 @@
+---
+name: 🚀 Enhancement/Feature Request
+about: Suggest something that could be improved or a New Feature to add
+labels: enhancement
+---
+
+<!--
+Thanks for thinking of a way to improve this project. If this solves a problem for you, then it probably solves that problem for lots of people! So the whole community will benefit from this request.
+
+
+Before creating a new feature request please search the issues for relevant feature requests.
+-->
+
+### Problem
+
+<!-- Provide a clear and concise description of what problem this feature will solve. For example:
+
+* I'm always frustrated when [...] because [...]
+* I would like it if [...] happened when I [...] because [...]
+-->
+
+### Proposed Solution
+
+<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
+
+* Add an option so that when [...]  [...] will happen
+ -->
+
+### Additional context
+
+<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:
+
+* Another project [...] solved this by [...]
+-->

dash_fn_form-0.0.1/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

dash_fn_form-0.0.1/.github/workflows/lint.yml

@@ -0,0 +1,19 @@
+name: Checks
+on: [push, pull_request]
+
+jobs:
+  prek:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: j178/prek-action@v1
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync --group dev
+      - name: ty
+        run: uv run ty check

dash_fn_form-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # required for OIDC
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

dash_fn_form-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --group test
+
+      - name: Tests
+        run: uv run pytest

dash_fn_form-0.0.1/.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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
+docs/generated
+
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# mac stuff
+.DS_store
+
+# editors
+
+## vim
+[._]*.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]
+[._]*.un~
+
+## vscode
+_notes.md
+_local_notes.md
+
+# setuptools-scm generated version file
+**/_version.py

dash_fn_form-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+minimum_prek_version: "0.2.0"
+exclude: "^uv\\.lock$"
+
+repos:
+  - repo: builtin
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: check-json
+      - id: check-json5
+      - id: check-toml
+      - id: check-yaml
+      - id: check-xml
+      - id: mixed-line-ending
+      - id: check-symlinks
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: check-executables-have-shebangs
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

dash_fn_form-0.0.1/.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Current File",
+            "type": "python",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": true
+        }
+    ]
+}

dash_fn_form-0.0.1/.vscode/linux.env

@@ -0,0 +1,3 @@
+# "${workspaceFolder}/src" is properly parsed and replacement is made by the debugger
+# Test explorer seems not to do replacement and thus  ${workspaceFolder}/src is not enough, therefore use "src" in addition
+PYTHONPATH=${workspaceFolder}/src:src:${env:PYTHONPATH}

dash_fn_form-0.0.1/.vscode/settings.json

@@ -0,0 +1,31 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "terminal.integrated.env.linux": {
+        "PYTHONPATH": "${workspaceFolder}/src:${env:PYTHONPATH}"
+    },
+    "terminal.integrated.env.windows": {
+        "PYTHONPATH": "${workspaceFolder}\\src;${env:PYTHONPATH}"
+    },
+    "terminal.integrated.env.osx": {
+        "PYTHONPATH": "${workspaceFolder}/src:${env:PYTHONPATH}"
+    },
+    "python.envFile": "${workspaceFolder}/.vscode/windows.env",
+    "jupyter.notebookFileRoot": "${workspaceFolder}/src",
+    "cSpell.enableFiletypes": [
+        "!python"
+    ],
+    "cSpell.words": [
+        "Plotly",
+        "plotly",
+        "Dash"
+    ],
+    "yaml.customTags": [
+        "!reference sequence"
+    ],
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    "python.languageServer": "Pylance"
+}

dash_fn_form-0.0.1/.vscode/windows.env

@@ -0,0 +1 @@
+PYTHONPATH=${workspaceFolder}\src;src;${env:PYTHONPATH}

dash_fn_form-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+Bug reports, feature requests, and pull requests are welcome on [GitHub](https://github.com/saemeon/dash-fn-form/issues).
+
+## Development setup
+
+```bash
+git clone https://github.com/saemeon/dash-fn-form
+cd dash-fn-form
+uv sync --group dev
+```
+
+Pre-commit hooks are managed with [prek](https://github.com/saemeon/prek). They run automatically on `git commit` once you have installed the dev dependencies.
+
+## Running checks
+
+```bash
+uv run ruff check .
+uv run ruff format --check .
+uv run ty check
+uv run pytest
+```
+
+## Building docs
+
+```bash
+uv sync --group doc
+uv run mkdocs serve
+```

dash_fn_form-0.0.1/LICENSE

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

dash_fn_form-0.0.1/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: dash-fn-form
+Version: 0.0.1
+Summary: Introspection-based UI engine for Plotly Dash — transform type-hinted Python functions into reactive Dash forms.
+Author-email: Simon Niederberger <s.niederberger@hotmail.com>
+Maintainer-email: Simon Niederberger <s.niederberger@hotmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/saemeon/dash-fn-form
+Project-URL: Repository, https://github.com/saemeon/dash-fn-form
+Keywords: plotly,dash,visualization,dashboard
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: annotated-types>=0.7.0
+Requires-Dist: dash>=4.0.0
+Requires-Dist: plotly>=6.6.0
+Dynamic: license-file
+
+[![PyPI](https://img.shields.io/pypi/v/dash-fn-form)](https://pypi.org/project/dash-fn-form/)
+[![Python](https://img.shields.io/pypi/pyversions/dash-fn-form)](https://pypi.org/project/dash-fn-form/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Dash](https://img.shields.io/badge/Dash-008DE4?logo=plotly&logoColor=white)](https://dash.plotly.com/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+[![prek](https://img.shields.io/badge/prek-checked-blue)](https://github.com/saemeon/prek)
+
+# dash-fn-form
+
+Introspection-based UI engine for Plotly Dash — transform type-hinted Python functions into reactive Dash forms.
+
+## Installation
+
+```bash
+pip install dash-fn-form
+```
+
+Most users should install [dash-interact](https://github.com/saemeon/dash-interact) instead, which includes this package and adds a convenience `page` API.
+
+## Usage
+
+```python
+from dash import Dash, html
+from dash_fn_form import build_fn_panel
+
+def sine_wave(amplitude: float = 1.0, frequency: float = 2.0):
+    import numpy as np, plotly.graph_objects as go
+    x = np.linspace(0, 6 * np.pi, 600)
+    return go.Figure(go.Scatter(x=x, y=amplitude * np.sin(frequency * x)))
+
+app = Dash(__name__)
+app.layout = html.Div([build_fn_panel(sine_wave)])
+app.run(debug=True)
+```
+
+`build_fn_panel` inspects the function signature and builds a form with matching controls. The return value is rendered automatically.
+
+## Type mapping
+
+| Python type | Control |
+|---|---|
+| `float` | Number input (or slider with `(min, max, step)`) |
+| `int` | Number input (integer step) |
+| `bool` | Checkbox |
+| `Literal[A, B, C]` | Dropdown |
+| `str` | Text input |
+| `date` / `datetime` | Date picker |
+| `list[T]` / `tuple[T, ...]` | Comma-separated input |
+| `T \| None` | Same as `T`, submits `None` when empty |
+
+## Field customization
+
+```python
+from dash_fn_form import Field
+
+form = FnForm("my_form", my_fn, title=Field(label="Title", col_span=2))
+```
+
+## License
+
+MIT

dash_fn_form-0.0.1/README.md

@@ -0,0 +1,63 @@
+[![PyPI](https://img.shields.io/pypi/v/dash-fn-form)](https://pypi.org/project/dash-fn-form/)
+[![Python](https://img.shields.io/pypi/pyversions/dash-fn-form)](https://pypi.org/project/dash-fn-form/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Dash](https://img.shields.io/badge/Dash-008DE4?logo=plotly&logoColor=white)](https://dash.plotly.com/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+[![prek](https://img.shields.io/badge/prek-checked-blue)](https://github.com/saemeon/prek)
+
+# dash-fn-form
+
+Introspection-based UI engine for Plotly Dash — transform type-hinted Python functions into reactive Dash forms.
+
+## Installation
+
+```bash
+pip install dash-fn-form
+```
+
+Most users should install [dash-interact](https://github.com/saemeon/dash-interact) instead, which includes this package and adds a convenience `page` API.
+
+## Usage
+
+```python
+from dash import Dash, html
+from dash_fn_form import build_fn_panel
+
+def sine_wave(amplitude: float = 1.0, frequency: float = 2.0):
+    import numpy as np, plotly.graph_objects as go
+    x = np.linspace(0, 6 * np.pi, 600)
+    return go.Figure(go.Scatter(x=x, y=amplitude * np.sin(frequency * x)))
+
+app = Dash(__name__)
+app.layout = html.Div([build_fn_panel(sine_wave)])
+app.run(debug=True)
+```
+
+`build_fn_panel` inspects the function signature and builds a form with matching controls. The return value is rendered automatically.
+
+## Type mapping
+
+| Python type | Control |
+|---|---|
+| `float` | Number input (or slider with `(min, max, step)`) |
+| `int` | Number input (integer step) |
+| `bool` | Checkbox |
+| `Literal[A, B, C]` | Dropdown |
+| `str` | Text input |
+| `date` / `datetime` | Date picker |
+| `list[T]` / `tuple[T, ...]` | Comma-separated input |
+| `T \| None` | Same as `T`, submits `None` when empty |
+
+## Field customization
+
+```python
+from dash_fn_form import Field
+
+form = FnForm("my_form", my_fn, title=Field(label="Title", col_span=2))
+```
+
+## License
+
+MIT