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.0.tar.gz (18.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.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.3.0.tar.gz
  • Upload date:
  • Size: 18.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.0.tar.gz
Algorithm Hash digest
SHA256 3ae9ade83930569a193d495d1fbb1ccaa1dc2b214cdc5761928be606623b2ac4
MD5 4640dd21fccc3b480735cb47426c2709
BLAKE2b-256 20079cb0cb655834e366ba47b43790e0d4945b8d2c74e3c69bb126dfb0dd9947

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 088d78c2713d43e5eae8d5e47daeffa1df53a10a24d4056160f794f4caebca23
MD5 976a7e78278799ad0b536f5428e234ad
BLAKE2b-256 efacc5a7e3a4c76717ec82e90233a02549fb4b27e4aff8fda561ae8146b7df7d

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