Overview¶

Ærende is a small, python based note taking application. Works offline and in the terminal via a curses interface. Navigation via vim-esque keys. Designed to slot easily into my comm workspace alongside weechat and neomutt.

Contents¶

Installation¶

Ærende requires python >= 3.6.

Via Pip¶

You can install ærende via pip, from pypi :

python3.6 -m pip install --user aerende

Via The Repo¶

To install ærende from the repo, you can clone it and set up a clean environment with virtualenv:

git clone git@github.com:Autophagy/aerende.git
cd aerende
virtualenv .venv -p python3.6
source .venv/bin/activate

Then, install the aerende package:

pip install -e .

You can now run aerende.

Release Notes¶

Information about each Ærende release.

0.X¶

0.2.X¶

0.2.0¶

Release Date :: 15 Forst 226 // 5 Dec 2017

Some documentation refactoring
Some configuration refactoring (data_path is now data_options: data_path)
Some general code refactoring and commenting
Fixed a configuration file path loading bug
Added super increment/decrement of note priority
Stripped whitespace from note body text returned from text editor
Enforce lower case on note tag input

0.1.X¶

0.1.1¶

Release Date :: 29 Hærfest 226 // 20 Oct 2017

First release of ærende.

Includes the ability to create, update and delete notes. Also includes the ability to increment and decrement a note’s priority, which affects sorting and colouration.

Creating, Editing and Deleting Notes¶

Notes can be created via n. The note editor prompt will open at the bottom, requiring a note title, a // seperated list of note tags, and then the default editor will open for the note’s content.

Editing a note is done via e. This will open the same note editor prompt, but with the note’s current values autofilled.

The note editing prompt can be cancelled with esc.

Deleting a note is done via d.

A note’s priority can be increased with + and decreased with -. You can also increment and decrement a note’s priority in intervals of 10 with alt + and alt -. This priority affects the sorting of notes, and notes with a priority of >= 10 are considered high priority.

Configuration¶

The configuration file for ærende is located in ~/.andgeloman/aerende/config.yml.

Data Path Options¶

Option	Description	Default
data_path	Path to note data yml file	~/.andgeloman/aerende/data.yml

Key Binding Options¶

Option	Description	Default
next_note	Move the note focus down the list	`j`, `down`
previous_note	Move the note focus up the list	`k`, `up`
new_note	Create a new note	`n`
edit_note	Edit the focused note	`e`
delete_note	Delete the focused note	`d`
increment_note_priority	Increment the focused note’s priority.	`+`
super_increment_note_priority	Increment the focused note’s priority by 10.	`meta +`
decrement_note_priority	Decrement the focused note’s priority.	`-`
super_decrement_note_priority	Increment the focused note’s priority by 10.	`meta -`

Palette Options¶

Palette options are in the form of:

palette_name:
  - foreground
  - background

Option	Description	Default
status_bar	Palette for the status bar	black, white
edit_bar	Palette for the note metadata edit bar.	black, light red
highlight_note	Palette for the currently focused note.	light blue, default
high_priority	Palette for a high priority (>= 10) note.	light red, default

Keybindings¶

These are the default keybindings for ærende. These can all be changed in the Configuration settings.

Key	Action
`j`	Move the note focus down the list
`k`	Move the note focus up the list

Note Creation/Editing/Deleting¶

Key	Action
`n`	Create a new note
`e`	Edit the focused note
`d`	Delete the focused note
`+`	Increment a note’s priority
`alt +`	Increment a note’s priority by 10
`-`	Decrement a note’s priority
`alt -`	Decrement a note’s priority by 10

Ærende Documentation

Ærende documentation