Skip to main content

KATA Markdown™ toolkit for human-AI collaboration: schema, validation, and template in a single file

Project description

gospelo-kata — KATA Markdown™ for Human-AI Collaboration

License: MIT Python 3.11+ AI Collaborative KATA Markdown

A document format and toolkit designed for human-AI collaboration. KATA Markdown™ embeds schema, data, and template in a single file — readable and actionable by both humans and AI without special instructions.

Why gospelo-kata?

When generating documents with AI, you often face problems: no structure, no round-trip, no validation, and AI needs coaching every time. gospelo-kata solves this with a single .kata.md file that contains schema definition, structured data, and a Jinja2-compatible template.

LiveMorph — Bidirectional Real-time Sync

LiveMorph Concept Diagram

Bidirectional sync between Data blocks and HTML body. Switch modes with one click from VS Code, with the current sync mode always visible in the status bar.

Human-AI Readable — Self-Describing Format

Embedded **Schema** and **Prompt** blocks let AI understand the template without external instructions. Humans read and edit the same file naturally. The build command means AI only needs to generate YAML data.

Secure Packaging — KATA ARchive™ (.katar)

Bundle template, schema, and prompt into a ZIP archive. SHA-256 integrity verification, file-type sandboxing, and AI prompt trust management included.

Installation

pip install gospelo-kata

# With Excel support
pip install gospelo-kata[excel]

Requires Python 3.11+.

Quick Start

# List available templates
gospelo-kata templates

# Generate .kata.md with built-in sample data
gospelo-kata build todo -o ./

# Edit the Data block → update body
gospelo-kata sync to-html todo.kata.md

# Validate
gospelo-kata lint todo.kata.md

Built-in Templates

Type Description
checklist Structured checklist with categories and status tracking
test_spec Test case specification with prerequisites and expected results
agenda Meeting agenda with decisions and action items

CLI Commands

Command Description
templates List available templates
init Initialize project from a template
render Render template to annotated output
assemble Combine built-in template + data into _tpl.kata.md
build Generate .kata.md from template (data arg optional)
lint Validate templates and rendered documents
extract Extract structured data from rendered output
validate Validate data against a schema
pack / pack-init Create .katar archives
export Export template parts
import-data Validate data.yml against schema
sync LiveMorph bidirectional sync (to-html / to-data)

See the CLI Reference for details.

VSCode Extension

Install from VS Marketplace:

  • Real-time lint (Problems panel)
  • LiveMorph sync (context menu / status bar)
  • Hover info for data-kata attributes
  • Preview CSS for kata styles

Documentation

License

MIT — free for commercial use. Documents and templates you create are yours. See LICENSE.md 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

gospelo_kata-0.5.0.tar.gz (108.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gospelo_kata-0.5.0-py3-none-any.whl (116.4 kB view details)

Uploaded Python 3

File details

Details for the file gospelo_kata-0.5.0.tar.gz.

File metadata

  • Download URL: gospelo_kata-0.5.0.tar.gz
  • Upload date:
  • Size: 108.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for gospelo_kata-0.5.0.tar.gz
Algorithm Hash digest
SHA256 432d47ffae22bd595867c2bca2006daa51c228d67f17e5218e2c95fcba0f8ee0
MD5 3e70b6cf56ad77511bfdf380b33f9f24
BLAKE2b-256 977292a08a32fa137a1483520ad143f2e72c502fe8e49cb1632e19e06ce99540

See more details on using hashes here.

File details

Details for the file gospelo_kata-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: gospelo_kata-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 116.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for gospelo_kata-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0c7072ad29e740038974148d01decfbf2e0d5b844b8e136e84cd48e2d31770f3
MD5 86d321af4a2d9c289c24731d706b4fee
BLAKE2b-256 20e4a98e8e831dfb0c65dba80dcb74d910606c26ca6843af11e496634747bc47

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