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.3.tar.gz (21.6 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.3-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.3.3.tar.gz
  • Upload date:
  • Size: 21.6 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.3.tar.gz
Algorithm Hash digest
SHA256 d23acb8b65858c5cc2043ffd0fb749cdfe1b718e1a16cff863a7b5c9fa966c5c
MD5 c62208b3f793d1867aa81627eb51658d
BLAKE2b-256 9ef4d63471fcca50833dabae7faf942ed4d631633269baa985c8a613fdbb58d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 24.9 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6acaf32054c00170e133462bd5233c68eedc35f17a03ce3eda367a66cceb73f5
MD5 6df8ce494168ccc408f305ae4ca363c6
BLAKE2b-256 27d69b5e3add9ef1c6af347a6f328a465a53521468fdd2dcfa7fadde8fbb3723

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