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.2.0.tar.gz (13.0 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.2.0-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for todoosy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9e26707dbbca8c8e4d8b5947deab6a6dd805f0d7af6c1a02ad358f6eabd1ef2f
MD5 0ab7bbfedc65f9cd5b3482c85ef83ae8
BLAKE2b-256 95315a5cca3342caf6981e8ba9f9aedcf009e989cb098300192c4331670a74a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 15.0 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1194331efc37b20122c6a7ee6f013064e58826bb5e8723217867f30616044eab
MD5 4459e87bf7905350307b5c2d2b67edd9
BLAKE2b-256 01cad95002e117486fe0c2e7e9997c9a6091d4a5a6b3d7b2443f5a36353ace62

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