stage-left

Documentation

  • Usage Examples
  • API Reference
  • Changelog

External Links

  • GitHub
  • PyPI
stage-left
  • stage-left
  • View page source

stage-left

[x]it! is a plain-text file format for todos and check lists. Stage-left parses [x]it! documents into python data structures.

Installation

pip install stage-left

Documentation

  • Usage Examples
    • Parse checklist from file
    • Parse checklist from string
  • API Reference
    • Parser functions
      • parse_file()
      • parse_text()
    • Exceptions
    • Data Types
      • State
        • State.OPEN
        • State.CHECKED
        • State.ONGOING
        • State.OBSOLETE
        • State.IN_QUESTION
      • Tag
        • Tag.value
        • Tag.key
      • Item
        • Item.state
        • Item.description
        • Item.tags
        • Item.priority
        • Item.due_date
        • Item.format_description()
      • Group
        • Group.title
        • Group.items
  • Changelog

External Links

  • GitHub
  • PyPI
Next

© Copyright 2022, Chris Shaw.

Built with Sphinx using a theme provided by Read the Docs.