Skip to main content

Create textual forms based on Pydantic models.

Project description

coverage PyPI - Version types - Mypy

Ticklist

Ticklist is a Python library designed to create interactive forms based on Pydantic models using the Textual framework. It provides a seamless way to generate user interfaces for data entry and editing, leveraging the power of Pydantic for data validation and Textual for building rich, interactive applications.

Features

  • Pydantic Integration: Automatically generate forms based on Pydantic models.
  • Textual Widgets: Use Textual's widgets to create a responsive and interactive user interface.
  • Annotation Handling: Supports various Pydantic annotations, including str, int, Enum, Literal, Union, and more.
  • Custom Annotations: Define custom annotations to control the behavior and appearance of form fields.
  • Validation: Automatically validate user input using Pydantic's validation rules.

Installation

You can install Ticklist using pip:

pip install ticklist

Usage

A simple example of how to use Ticklist to create a form for a Pydantic model:

{{include "example.py"}}

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md file for guidelines on how to contribute to this project.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ticklist-0.6.0.tar.gz (161.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ticklist-0.6.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file ticklist-0.6.0.tar.gz.

File metadata

  • Download URL: ticklist-0.6.0.tar.gz
  • Upload date:
  • Size: 161.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.11

File hashes

Hashes for ticklist-0.6.0.tar.gz
Algorithm Hash digest
SHA256 148cc64c50137d67f7290db2a2943a9e8beb6858deae7221ec38101d4e760128
MD5 f8240f2d5067cfc79d2383b0d7622ebd
BLAKE2b-256 01fe38436f3c95c414b2578d1debe9332a90dc82933faa9511d6ec09a3d49e93

See more details on using hashes here.

File details

Details for the file ticklist-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: ticklist-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.11

File hashes

Hashes for ticklist-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eedf0553124ac70a042ce9479a1c0009f75bc19e573c438e18c7d6a01f17c004
MD5 f5b1a0c7cbb39ab97aaaaada9b0a3273
BLAKE2b-256 d8638a10704bc145195b93c606cb86c71352923399d938a82dad9f2149f3dedf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page