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.1.tar.gz (13.3 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.1-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: todoosy-0.2.1.tar.gz
  • Upload date:
  • Size: 13.3 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.1.tar.gz
Algorithm Hash digest
SHA256 93b13cbdf83abe1d6090819ec151127df486498f997835d29def84ca94b80df9
MD5 3b766f1618a215fed54b39fc79f9c5d8
BLAKE2b-256 23978b2ec36b8815e0880af9096e3c5436ae0645c03fdcf2577d73f748795f37

See more details on using hashes here.

File details

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

File metadata

  • Download URL: todoosy-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 15.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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9bd22c672f7397c5eb22721ddb8b7da5cc4ce513e6941cdd44c0680ca33de0f4
MD5 f1e0a3661876effc19a3f2adc5704a45
BLAKE2b-256 7e1e1d4cfbd3c06903e80c5da6d0f4f0eb84a2c5ba143a43d6baae421a5f848e

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