Skip to main content

IntentText - the semantic document format that is natively JSON

Project description

IntentText Python

PyPI

Python implementation of the IntentText parser and renderer.

Independent implementation (not a Node.js wrapper), designed for Python workflows and AI stacks.

Install

pip install intenttext

Quick Start

from intenttext import parse, render_html, merge_data, validate, query

# Parse a document
source = """
title: Sprint Planning
section: Tasks
task: Write tests | owner: Ahmed | due: Friday
task: Deploy to staging | owner: Sarah | due: Monday
gate: Final approval | approver: Lead | timeout: 24h
""".strip()

doc = parse(source)

# Query for tasks
tasks = query(doc, type="task")
for task in tasks:
    print(f"{task.content} -> {task.properties.get('owner', 'unassigned')}")

# Validate workflow semantics
result = validate(doc)
if not result.valid:
    for issue in result.issues:
        print(f"[{issue.type.upper()}] {issue.message}")

# Render to HTML
html = render_html(doc)

API

  • parse(source: str) -> IntentDocument
  • parse_safe(source: str, ...) -> ParseResult
  • render_html(doc: IntentDocument, include_css: bool = True) -> str
  • render_print(doc: IntentDocument) -> str
  • render_markdown(doc: IntentDocument) -> str
  • merge_data(template: IntentDocument, data: dict) -> IntentDocument
  • parse_and_merge(template_source: str, data: dict) -> IntentDocument
  • validate(doc: IntentDocument) -> ValidationResult
  • query(doc: IntentDocument, ...) -> list[IntentBlock]
  • to_source(doc: IntentDocument) -> str

Development

pip install -e .[dev]
pytest

Release (PyPI)

# 1) Ensure tests pass
python3 -m pytest -q

# 2) Build source + wheel
python3 -m pip install -U hatch twine
hatch build

# 3) Validate package metadata and long description
twine check dist/*

# 4) Upload (interactive)
twine upload dist/*

Tag-based release flow:

git tag v1.0.0
git push origin v1.0.0

GitHub Action publish workflow uses PYPI_API_TOKEN for automated release on v* tags.

License

MIT

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

intenttext-2.13.2.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

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

intenttext-2.13.2-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file intenttext-2.13.2.tar.gz.

File metadata

  • Download URL: intenttext-2.13.2.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for intenttext-2.13.2.tar.gz
Algorithm Hash digest
SHA256 fe395588098cd03dbfa78015cebcc627391e051792c9ac83c726a444f00d6aea
MD5 b1400d30ca2435e0daa0842a1defa710
BLAKE2b-256 20d7839e16e57e1393ae516d8fcfae0e01737e1c02c84301e4faf9b6e834f1b7

See more details on using hashes here.

File details

Details for the file intenttext-2.13.2-py3-none-any.whl.

File metadata

  • Download URL: intenttext-2.13.2-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for intenttext-2.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 599e57c65a23b1ada003ae12fb67d0d15ea25fb30f5777b0817553eb5d6c4f54
MD5 2a04467c3a5a1db02cbcc95bebd7cd34
BLAKE2b-256 0ccaffb3152c3ddf8c2e6633946877125e8778362756a9d11a6a582e02513abc

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