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.9.0.tar.gz (73.5 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.9.0-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ticklist-0.9.0.tar.gz
Algorithm Hash digest
SHA256 4e4fdbcab1d5bee8845160394dc9b9f1692fd6bfa9977ca4bbf5dfb686b04c96
MD5 8483e3f1a8fbf2c0946810e34f0fe083
BLAKE2b-256 577523c6b81cc6a3767bf19caebb93d80b8434dadb86173b4522da400906e679

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ticklist-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f58758a5b5f68b45a94860e775d35e23b3f88b97ea961aebf0a2c686f2769392
MD5 8a1025254e7e8b88400dce45e6b949ba
BLAKE2b-256 e7d06036a554ce0a3ba7bf5a99ec954b507f56632ee53ed6431a77b2f4f1bca2

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