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.6.tar.gz (16.8 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.6-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.2.6.tar.gz
  • Upload date:
  • Size: 16.8 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.6.tar.gz
Algorithm Hash digest
SHA256 dabe88e105e3271bb6c47d46df90a2ed9d03be1d94e60d73d5cd44272b0be302
MD5 1e84b3a7ca24dbe22ce9e90749c65ffa
BLAKE2b-256 ced982ac8fab76a5c3f7b97570ee9779c45bd3c39100f4a22543c6173a00671b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 19.2 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 de2a47948ed70256692dd2c976bb305b4d4587462da2742076930f6dd972ae06
MD5 bfc8eab43b312c34729141c3d3742097
BLAKE2b-256 94a1ec5225883b2d752c56953bcb508780de43b34f0343afc5cd2bac1cd187c2

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