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.8.0.tar.gz (58.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.8.0-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ticklist-0.8.0.tar.gz
Algorithm Hash digest
SHA256 3a18baca4da34938e95486e7f89230b2cae0b0171e5eee34fe4c30ea4cbcbb98
MD5 2d33400415ae75a3a4abb986d8d9b578
BLAKE2b-256 98710cc505ef09f86b1631430e07acf010301dee96c4eb88a9d64eb51fddfd7f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ticklist-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 967305dd07ac3867f2b4b40c3f63cb960908f15f3a19120aa0f9e38caa56e252
MD5 e86e5c1a423affefdf3012d880418e84
BLAKE2b-256 7add8632dfba50b52218db502ce082de4130297119eeb2f5bbbe3ee65ce03893

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