pytypeinput 0.1.0__tar.gz

pytypeinput-0.1.0/.gitignore

@@ -0,0 +1,216 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pytypeinput-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2011-2025 The Bootstrap Authors
+
+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.

pytypeinput-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: pytypeinput
+Version: 0.1.0
+Summary: Type hints → UI metadata. Build forms from Python function signatures.
+Project-URL: Repository, https://github.com/offerrall/pytypeinput
+Author: Beltrán Offerrall
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: html
+Requires-Dist: jinja2>=3.0.0; extra == 'html'
+Description-Content-Type: text/markdown
+
+# pytypeinput 0.1.0
+
+<div align="center">
+
+[![PyPI version](https://img.shields.io/pypi/v/pytypeinput.svg)](https://pypi.org/project/pytypeinput/)
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![Tests](https://img.shields.io/badge/tests-661%20passed-brightgreen.svg)](tests/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+**Extract structured metadata from Python type hints.**
+
+</div>
+
+---
+
+pytypeinput analyzes Python type hints and extracts structured metadata. Use this metadata to build UIs, CLIs, config editors, or anything that needs input specifications.
+```python
+from dataclasses import dataclass
+from pytypeinput import Field, Annotated, analyze_dataclass
+
+@dataclass
+class User:
+    username: Annotated[str, Field(min_length=3, max_length=20)]
+    age: Annotated[int, Field(ge=18, le=120)]
+    bio: str | None = None
+
+# Extract metadata
+params = analyze_dataclass(User)
+# Use it to build: HTML forms, CLIs, GUIs, validators...
+```
+
+## Design Goals
+
+- **Single source of truth** - Define once with type hints, use everywhere (forms, CLIs, validation)
+- **Minimal code** - Maximum features with minimum boilerplate
+- **Type-safe** - Full IDE autocomplete and type checking
+- **Pure Python** - Build UIs with Python code, not templates or DSLs
+
+## Installation
+Core only:
+```bash
+pip install pytypeinput
+```
+With HTML renderer:
+```bash
+pip install pytypeinput[html]
+```
+
+**Requirements:** Python 3.10+ • Pydantic 2.0+
+
+## Documentation
+
+**[Complete Documentation](https://offerrall.github.io/pytypeinput)** with interactive examples
+
+**Type System:**
+- **[Basic Types](https://offerrall.github.io/pytypeinput/basic-types/)**: `int`, `float`, `str`, `bool`, `date`, `time`
+- **[Special Types](https://offerrall.github.io/pytypeinput/special-types/)**: `Email`, `Color`, `File`, `ImageFile`, etc.
+- **[Lists](https://offerrall.github.io/pytypeinput/lists/)**: `list[Type]` with item and list-level validation
+- **[Optionals](https://offerrall.github.io/pytypeinput/optionals/)**: `Type | None` with toggle switches
+- **[Choices](https://offerrall.github.io/pytypeinput/choices/)**: `Literal`, `Enum`, `Dropdown(func)`
+- **[Constraints](https://offerrall.github.io/pytypeinput/constraints/)**: `Field(min=, max=, pattern=)` for validation
+- **[UI Metadata](https://offerrall.github.io/pytypeinput/ui-metadata/)**: Custom labels, descriptions, placeholders, sliders, etc.
+
+**Renderers:**
+- **[HTML Renderer](https://offerrall.github.io/pytypeinput/html-renderer/)** - Generate forms with client-side validation
+
+**Reference:**
+- **[API Reference](https://offerrall.github.io/pytypeinput/api/)** - Complete API documentation
+
+## What pytypeinput does
+
+✅ Extracts metadata from type hints  
+✅ Works with functions, dataclasses, Pydantic models, classes  
+✅ Optional HTML renderer with client-side validation  
+✅ Framework-agnostic  
+
+❌ No server-side validation  
+❌ No form submission handling
+
+**pytypeinput is a building block, not a complete solution.**
+
+> **Validation:** Type hints validated when extracting metadata. HTML forms validate client-side. Server-side is your responsibility (use Pydantic with same type hints).
+
+## Contributing
+
+Found a bug or have a suggestion? [Open an issue](https://github.com/offerrall/pytypeinput/issues)
+
+## License
+
+MIT • [Beltrán Offerrall](https://github.com/offerrall)

pytypeinput-0.1.0/README.md

@@ -0,0 +1,90 @@
+# pytypeinput 0.1.0
+
+<div align="center">
+
+[![PyPI version](https://img.shields.io/pypi/v/pytypeinput.svg)](https://pypi.org/project/pytypeinput/)
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![Tests](https://img.shields.io/badge/tests-661%20passed-brightgreen.svg)](tests/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+**Extract structured metadata from Python type hints.**
+
+</div>
+
+---
+
+pytypeinput analyzes Python type hints and extracts structured metadata. Use this metadata to build UIs, CLIs, config editors, or anything that needs input specifications.
+```python
+from dataclasses import dataclass
+from pytypeinput import Field, Annotated, analyze_dataclass
+
+@dataclass
+class User:
+    username: Annotated[str, Field(min_length=3, max_length=20)]
+    age: Annotated[int, Field(ge=18, le=120)]
+    bio: str | None = None
+
+# Extract metadata
+params = analyze_dataclass(User)
+# Use it to build: HTML forms, CLIs, GUIs, validators...
+```
+
+## Design Goals
+
+- **Single source of truth** - Define once with type hints, use everywhere (forms, CLIs, validation)
+- **Minimal code** - Maximum features with minimum boilerplate
+- **Type-safe** - Full IDE autocomplete and type checking
+- **Pure Python** - Build UIs with Python code, not templates or DSLs
+
+## Installation
+Core only:
+```bash
+pip install pytypeinput
+```
+With HTML renderer:
+```bash
+pip install pytypeinput[html]
+```
+
+**Requirements:** Python 3.10+ • Pydantic 2.0+
+
+## Documentation
+
+**[Complete Documentation](https://offerrall.github.io/pytypeinput)** with interactive examples
+
+**Type System:**
+- **[Basic Types](https://offerrall.github.io/pytypeinput/basic-types/)**: `int`, `float`, `str`, `bool`, `date`, `time`
+- **[Special Types](https://offerrall.github.io/pytypeinput/special-types/)**: `Email`, `Color`, `File`, `ImageFile`, etc.
+- **[Lists](https://offerrall.github.io/pytypeinput/lists/)**: `list[Type]` with item and list-level validation
+- **[Optionals](https://offerrall.github.io/pytypeinput/optionals/)**: `Type | None` with toggle switches
+- **[Choices](https://offerrall.github.io/pytypeinput/choices/)**: `Literal`, `Enum`, `Dropdown(func)`
+- **[Constraints](https://offerrall.github.io/pytypeinput/constraints/)**: `Field(min=, max=, pattern=)` for validation
+- **[UI Metadata](https://offerrall.github.io/pytypeinput/ui-metadata/)**: Custom labels, descriptions, placeholders, sliders, etc.
+
+**Renderers:**
+- **[HTML Renderer](https://offerrall.github.io/pytypeinput/html-renderer/)** - Generate forms with client-side validation
+
+**Reference:**
+- **[API Reference](https://offerrall.github.io/pytypeinput/api/)** - Complete API documentation
+
+## What pytypeinput does
+
+✅ Extracts metadata from type hints  
+✅ Works with functions, dataclasses, Pydantic models, classes  
+✅ Optional HTML renderer with client-side validation  
+✅ Framework-agnostic  
+
+❌ No server-side validation  
+❌ No form submission handling
+
+**pytypeinput is a building block, not a complete solution.**
+
+> **Validation:** Type hints validated when extracting metadata. HTML forms validate client-side. Server-side is your responsibility (use Pydantic with same type hints).
+
+## Contributing
+
+Found a bug or have a suggestion? [Open an issue](https://github.com/offerrall/pytypeinput/issues)
+
+## License
+
+MIT • [Beltrán Offerrall](https://github.com/offerrall)