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.1.0.tar.gz (11.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.1.0-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.1.0.tar.gz
  • Upload date:
  • Size: 11.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.1.0.tar.gz
Algorithm Hash digest
SHA256 6ba86a9a9f6bf78cba94e926de65028d28fb8f2efe42be4ab91c272c031225ce
MD5 a7418e70a9c070887c4dc76727f3e27b
BLAKE2b-256 8275ab6e4ade243e35a3433efab7b0f14e872963f2d6d9b7a914b5965a0946ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.4 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c20fe4356226850f8d51e05cbbdeacbfc98b6a93bdf703d3f7b7f7d589ace06a
MD5 9dd4d3c6c8c47b53b6ca17b8051d4d3f
BLAKE2b-256 b79c21f8bab6fce1934ca68094cde0c23cdda057fc78cb6efbaf4f4d5c0fc5e6

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