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.2.tar.gz (19.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.2-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.3.2.tar.gz
  • Upload date:
  • Size: 19.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.2.tar.gz
Algorithm Hash digest
SHA256 b3bbe97278b5b67d716a30ea18b7d39e0e1c08a0711679f54d673d63d65d148b
MD5 35eb8b6a9d31ed15f5a7b4f90b846f0c
BLAKE2b-256 82b959417febee8d6fea4e3ad326adad09857cb128fc5cba3b3e95f0ac84cf88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 22.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 eb2581d0aed540b94ae615df145c000e8d27c9c8b20d04f10a45c3e25db44a50
MD5 470cd3133f5bc57aabb229f19e67087b
BLAKE2b-256 db776d07cfcde3406cbcd076518619efac5144480c168b97b181237d81b719ce

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