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.5.tar.gz (15.4 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.5-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.2.5.tar.gz
  • Upload date:
  • Size: 15.4 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.5.tar.gz
Algorithm Hash digest
SHA256 90de6fbdf513307530254a154fdeb0371a4d0d1988d4c2c9d6d7b34c0fdc7266
MD5 67b500abf98b2df047a279522393229c
BLAKE2b-256 96f1b2a1aaedfc32ba09bf0cfdebf9a44e10d89e7e016cf3d7d581f1d5dfc357

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 17.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.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 96adbdfd7b44b95344c7b58cdefdc763da5dabaabbac9681ac4837e8119fb035
MD5 8fb4feebdc18193607397f306258a602
BLAKE2b-256 753bebb24d6b1f4d3672da9a36172c7f0c34f9820d011291628accacd0f2c87f

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