API

This file defines the API for backlog.

class backlog.Backlog(entries: List[Entry] = <factory>)

A Backlog is a list of Backlog.Entry objects.

class Entry(title: str, priority: int = 0, note: str = '')

A Backlog.Entry is a note with a title and a priority.

summary() → str

Produce a one-line string less than 81 characters.

classmethod load(path: str) → backlog.api.Backlog

Load a Backlog from a file.

random() → Optional[Entry]

Randomly pick an Entry from a distribution weighted by priority.

save(path: str) → None

Save a Backlog to a file.

search(pattern: str, invert: bool = False) → Generator[Entry, None, None]

Find Entries in the Backlog.