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.4.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.4-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.3.4.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.4.tar.gz
Algorithm Hash digest
SHA256 8b0934132c20b987a6878f7a863be5ee19b36f3891b99ce1cb7cd2faa4391fc9
MD5 3f73b93a5dc83c2246d0c53498cf567c
BLAKE2b-256 0525c09c3a8613458cbe90625dc91bee3282ef86883f68993b92e144d4293008

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.3.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1059d3e06e67e2550ddda8cf4eaa193c19153c9852f0348df500503e6961a22d
MD5 ae11f19daaeb49436b42ed4d98379428
BLAKE2b-256 010181571f78c9ffa25ac45ce840ea3c74d53b098cbb55802b8071414a497b86

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