Ærende

Ærende is a tool to facilitate the recording of reminders, similar to post-it notes. Written in python, with a curses UI via the urwid library. Documentation is available on ReadTheDocs.

Installation

Via Pip

To install ærende via pip, from pypi:

python3.6 -m pip install --user aerende

Via The Repo

To install via the repo, you can set up a clean environment with virtualenv:

virtualenv .venv -p python3.6
source .venv/bin/activate

Then, install the aerende package:

pip install -e .

You can now run aerende.

Documentation

To build the documentation, install the requirements via:

pip install -r requirements.txt

In the doc folder, there is a Makefile to build the documentation. For example, to build the HTML documentation:

cd doc
make html

The documentation is automatically built and deployed on ReadTheDocs.

Tests

You can run the tests via python -m unittest