Metadata-Version: 2.3
Name: shai_tix
Version: 0.1.1
Summary: File-based task management for AI agents with human-editable markdown storage.
License: MIT
Author: Sanhe Hu
Author-email: husanhe@email.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@email.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: auto
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: SQLAlchemy (>=2.0.45,<3.0.0)
Requires-Dist: Sphinx (>=7.4.7,<8.0.0) ; extra == "doc"
Requires-Dist: build (>=1.2.1,<2.0.0) ; extra == "dev"
Requires-Dist: docfly (==3.0.0) ; extra == "doc"
Requires-Dist: fire (>=0.7.1,<1.0.0)
Requires-Dist: furo (==2024.8.6) ; extra == "doc"
Requires-Dist: ipython (>=8.18.1,<8.19.0) ; extra == "doc"
Requires-Dist: nbsphinx (>=0.8.12,<1.0.0) ; extra == "doc"
Requires-Dist: pygments (>=2.18.0,<3.0.0) ; extra == "doc"
Requires-Dist: pytest (>=8.2.2,<9.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=6.0.0,<7.0.0) ; extra == "test"
Requires-Dist: rich (>=13.8.1,<14.0.0) ; extra == "dev"
Requires-Dist: rstobj (==1.2.1) ; extra == "doc"
Requires-Dist: sphinx-copybutton (>=0.5.2,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-design (>=0.6.1,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-jinja (>=2.0.2,<3.0.0) ; extra == "doc"
Requires-Dist: twine (>=6.0.0,<7.0.0) ; extra == "dev"
Requires-Dist: wheel (>=0.45.0,<1.0.0) ; extra == "dev"
Project-URL: Changelog, https://github.com/MacHu-GWU/shai_tix-project/blob/main/release-history.rst
Project-URL: Documentation, https://shai-tix.readthedocs.io/en/latest/
Project-URL: Download, https://pypi.org/pypi/shai-tix#files
Project-URL: Homepage, https://github.com/MacHu-GWU/shai_tix-project
Project-URL: Issues, https://github.com/MacHu-GWU/shai_tix-project/issues
Project-URL: Repository, https://github.com/MacHu-GWU/shai_tix-project
Description-Content-Type: text/x-rst


.. image:: https://readthedocs.org/projects/shai-tix/badge/?version=latest
    :target: https://shai-tix.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/shai_tix-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/shai_tix-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/shai_tix-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/shai_tix-project

.. image:: https://img.shields.io/pypi/v/shai-tix.svg
    :target: https://pypi.python.org/pypi/shai-tix

.. image:: https://img.shields.io/pypi/l/shai-tix.svg
    :target: https://pypi.python.org/pypi/shai-tix

.. image:: https://img.shields.io/pypi/pyversions/shai-tix.svg
    :target: https://pypi.python.org/pypi/shai-tix

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/shai_tix-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/shai_tix-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://shai-tix.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/shai_tix-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/shai_tix-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/shai_tix-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/shai-tix#files


Welcome to ``shai_tix`` Documentation
==============================================================================
.. image:: https://shai-tix.readthedocs.io/en/latest/_static/shai_tix-logo.png
    :target: https://shai-tix.readthedocs.io/en/latest/

File-based task management for AI agents with human-editable markdown storage.


What is shai_tix?
------------------------------------------------------------------------------

``shai_tix`` is a task management system designed **primarily for AI agents**
(like Claude Code) while remaining **fully accessible to humans**. It uses
plain files and directories as storage, so both AI and humans can read, edit,
and track changes through git.


Design Philosophy
------------------------------------------------------------------------------

**AI-First, Human-Friendly**

- **For AI**: CLI interface (``shai-tix``) with simple text output that AI can parse
- **For Humans**: Markdown files you can browse, edit, and version control

**Dual Storage Architecture**

- **Filesystem (Source of Truth)**: Human-readable directories and markdown files
- **SQLite Index (Cache)**: Fast queries without scanning directories

**Simple Two-Level Hierarchy**

::

    Story (Feature or Epic)
    └── Task (Atomic work unit)

No deep nesting. If a task needs subtasks, promote it to a story.


Quick Start
------------------------------------------------------------------------------

**For AI Agents (CLI)**::

    # Create a story and tasks
    shai-tix create_story "User Authentication" --description "Implement login/logout"
    shai-tix create_task 1 "Create login form"
    shai-tix create_task 1 "Add session management"

    # Query and update
    shai-tix list_stories
    shai-tix update_task 2 --status COMPLETED

**For Humans (File System)**::

    .tix/
    └── stories/
        └── story-2025-01-15-00001-user-authentication/
            ├── metadata.json          # {"status": "IN_PROGRESS"}
            ├── description.md         # Editable markdown
            └── tasks/
                └── task-2025-01-15-00002-create-login-form/
                    ├── metadata.json
                    └── description.md


.. _install:

Install
------------------------------------------------------------------------------

``shai_tix`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install shai-tix

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade shai-tix

