Skip to content

sander76/ticklist

Repository files navigation

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.

About

textual forms based on pydantic data models.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages