Skip to main content

No project description provided

Project description

stage-left

Run tests codecov PyPI Version License Python Compatibility Code style: black

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

Installation

pip install stage-left

Usage

Parse checklist from file

from stage_left import parse_file, ParseError

with open("/path/to/checklist.xit") as fp:
    try:
        checklist = parse_file(fp)
        print(checklist)
    except ParseError:
        raise

Parse checklist from string

from stage_left import parse_text, ParseError

text = """
[ ] Open
[x] Done
"""

try:
    checklist = parse_text(text)
    print(checklist)
except ParseError:
    raise

Implementation notes

Due dates specified using the numbered week syntax e.g: 2022-W01 are parsed assuming Monday is the first day of the week. All days in a new year preceding the first Monday are considered to be in week 0 (W00).

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

stage-left-0.1.1.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

stage_left-0.1.1-py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page