ticklist


Nameticklist JSON
Version 0.7.0 PyPI version JSON
download
home_pageNone
SummaryCreate textual forms based on Pydantic models.
upload_time2025-09-12 14:45:11
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords cli forms pydantic textual
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/sander76/a25f1e6bfcb3b085ffe05f520b56e43c/raw/covbadge.json)
[![PyPI - Version](https://img.shields.io/pypi/v/clipstick.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/clipstick/)
[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/ambv/black)

# 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:

```bash
pip install ticklist
```

## Usage

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

```python
{{include "example.py"}}
```

## Contributing

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

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ticklist",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "cli, forms, pydantic, textual",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/3c/5d/82b28f811f992f7db111f438735c6faaa9fd772614a2102cd8cdb2f140bb/ticklist-0.7.0.tar.gz",
    "platform": null,
    "description": "![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/sander76/a25f1e6bfcb3b085ffe05f520b56e43c/raw/covbadge.json)\n[![PyPI - Version](https://img.shields.io/pypi/v/clipstick.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/clipstick/)\n[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/ambv/black)\n\n# Ticklist\n\nTicklist 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.\n\n## Features\n\n- **Pydantic Integration**: Automatically generate forms based on Pydantic models.\n- **Textual Widgets**: Use Textual's widgets to create a responsive and interactive user interface.\n- **Annotation Handling**: Supports various Pydantic annotations, including `str`, `int`, `Enum`, `Literal`, `Union`, and more.\n- **Custom Annotations**: Define custom annotations to control the behavior and appearance of form fields.\n- **Validation**: Automatically validate user input using Pydantic's validation rules.\n\n## Installation\n\nYou can install Ticklist using pip:\n\n```bash\npip install ticklist\n```\n\n## Usage\n\nA simple example of how to use Ticklist to create a form for a Pydantic model:\n\n```python\n{{include \"example.py\"}}\n```\n\n## Contributing\n\nContributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to this project.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Create textual forms based on Pydantic models.",
    "version": "0.7.0",
    "project_urls": {
        "Repository": "https://github.com/sander76/clipstick"
    },
    "split_keywords": [
        "cli",
        " forms",
        " pydantic",
        " textual"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "615b55922b65dfaf1575b24dad3e9b1e0c42d6cbe82c5d47fa5899c52d760bb7",
                "md5": "731fea845dfe68eb019a556e9bab4411",
                "sha256": "a9de63256d3492a6a2f23630be61e1cbddad90028976a0ccc8fa91e5d5008daa"
            },
            "downloads": -1,
            "filename": "ticklist-0.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "731fea845dfe68eb019a556e9bab4411",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 15037,
            "upload_time": "2025-09-12T14:45:10",
            "upload_time_iso_8601": "2025-09-12T14:45:10.237271Z",
            "url": "https://files.pythonhosted.org/packages/61/5b/55922b65dfaf1575b24dad3e9b1e0c42d6cbe82c5d47fa5899c52d760bb7/ticklist-0.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3c5d82b28f811f992f7db111f438735c6faaa9fd772614a2102cd8cdb2f140bb",
                "md5": "b756150c5dc8bf2f639ec32e6e359ac7",
                "sha256": "f1190c6c43b04fc39c306d030b7e4c9ba3151e82c483a1e5b7fe33fa49f39a09"
            },
            "downloads": -1,
            "filename": "ticklist-0.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b756150c5dc8bf2f639ec32e6e359ac7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 142563,
            "upload_time": "2025-09-12T14:45:11",
            "upload_time_iso_8601": "2025-09-12T14:45:11.991605Z",
            "url": "https://files.pythonhosted.org/packages/3c/5d/82b28f811f992f7db111f438735c6faaa9fd772614a2102cd8cdb2f140bb/ticklist-0.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-12 14:45:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sander76",
    "github_project": "clipstick",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ticklist"
}
        
Elapsed time: 1.62426s