Skip to main content

A Glorified TODO list

Project description

Track prioritized notes with this glorified TODO list.

Installation

Use pip to install Backlog.

pip install backlog

Usage

Backlog can be invoked from a command-line or imported in Python.

CLI

$ backlog --help
Usage: backlog [OPTIONS] COMMAND [ARGS]...

  Manage a Backlog.

Options:
  --path PATH  Specify the path to use for the backlog file.
  --version    Show the version and exit.
  --help       Show this message and exit.

Commands:
  add     Add an entry to the backlog.
  random  Select a random entry from the backlog.
  remove  Remove entries from the backlog.
  show    Show entries in the backlog.
$ backlog add --priority 100 'Pay the water bill'
$ backlog add --priority 200 --note "eggs, bread, milk" 'Buy groceries'
$ backlog add 'Clean out the freezer'
$ backlog show
total 3
Pay the water bill             100
Buy groceries                  200  eggs, bread, milk
Clean out the freezer            0
$ backlog random
Buy groceries
priority: 200
eggs, bread, milk
$ backlog show --pattern bill
total 1
Pay the water bill             100

API

>>> from backlog import Backlog
>>> help(Backlog)
>>> backlog = Backlog(
...     entries=[
...         Backlog.Entry('Pay the water bill', priority=100),
...         Backlog.Entry('Buy groceries', priority=200, note='eggs, bread, milk'),
...         Backlog.Entry('Clean out the freezer'),
...     ],
... )
>>> backlog.random()
Backlog.Entry(title='Buy groceries', priority=200, note='eggs, bread, milk')
>>> list(backlog.search('bill'))
[Backlog.Entry(title='Pay the water bill', priority=100, note='')]

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

backlog-2.0.4.tar.gz (22.6 kB view hashes)

Uploaded source

Built Distribution

backlog-2.0.4-py3-none-any.whl (13.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page