Skip to main content

Todoosy - Markdown-based todo system parser, formatter, linter, and query engine

Project description

Todoosy Python Library

Python implementation of the Todoosy format parser, formatter, linter, and query engine.

Installation

pip install -e .

For development:

pip install -e ".[dev]"

Usage

from todoosy import parse, format, lint, query_upcoming, query_misc, parse_scheme

# Parse a document
result = parse('''
# Work

- Task (due 2026-01-15 p1 2h)

# Misc
''')

# Access the AST
for item in result.ast.items:
    print(f"{item.title_text}: due={item.metadata.due}")

# Format a document
formatted = format(input_text)

# Lint a document
warnings = lint(input_text)
for w in warnings.warnings:
    print(f"{w.code}: {w.message}")

# Query upcoming items
scheme = parse_scheme(scheme_text)
upcoming = query_upcoming(input_text, scheme)
for item in upcoming.items:
    print(f"{item.path}: {item.due}")

# Query misc items
misc = query_misc(input_text)
for item in misc.items:
    print(item.title_text)

Running Tests

pytest

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

todoosy-0.3.7.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

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

todoosy-0.3.7-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file todoosy-0.3.7.tar.gz.

File metadata

  • Download URL: todoosy-0.3.7.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for todoosy-0.3.7.tar.gz
Algorithm Hash digest
SHA256 24a2dabb97d0cbc7e08a0df53d41da58deaea0e41f56a0ffb5abcff89928259e
MD5 18fe3ea4cc48d0ff6bf78ccfe36daee8
BLAKE2b-256 238805226cf49ff8ef4ea7be376223e2e61598f257c723ceba93348dd08b866f

See more details on using hashes here.

File details

Details for the file todoosy-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: todoosy-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 29.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for todoosy-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c00ec6a7aead6aa0b6e4699dc31ad1af25ebd7f24033e5716bcce567b7cbe436
MD5 32aa1ebec183ed03db67753508db8e76
BLAKE2b-256 434aee9ce051ead70db321e3d746679242706c707d4be3d262dc47f4f37fce74

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