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

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.3.1.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.1.tar.gz
Algorithm Hash digest
SHA256 817eb66adb767960c4901db71d1c6f0c5d1ad5e4d2c4b8b1ffcddd5ae02e008f
MD5 f4de5649cff64170dd7dc80fd9aef66d
BLAKE2b-256 57a15a014c6c90517f5a882dd6f9ed61beefbf7b856bb21561dee36d7fc293bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.3.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1ed8cffb0b6ece4ae8f16e34c8573f267bf51d1a5892c8296142fa1e615a99e
MD5 4fe96e3fa5bb73c6e469c4963c5e9347
BLAKE2b-256 1d2f38b89364f38b99b07deea4da8aa1f9e16112b67e12cf9fe8b77dcbecac8d

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