Eichhörnchen

Lightweight curses-based time tracking tool.

Table of contents

1. Table of contents
2. Features
3. Installation
4. Configuration
5. Usage

Features

• start and stop tasks
• add new tasks
• edit or remove existing tasks
• list tasks
• sum up run times
• show summary
• export tasks to CSV or JSON

Also,

• curses-based user interface
• standard library only

Installation

To install Eichhörnchen using pip run the following command:

pip install eichhoernchen

Configuration

The default location of the configuration file is ~/.config/eichhoernchen.ini. An alternate configuration file can be specified using the -c, --config argument.

Minimal configuration

The configuration file is an INI file and has to contain at least the following section:

[database]
dbname = eichhoernchen.db
path = /home/user/.local/share

The dbname specifies the name of the SQLite3 database, and path its path.

Aliases

To define aliases for the commands, add the aliases section to define one or more aliases per command:

[aliases]
list = ["ls"]
remove = ["rm", "rem"]

Usage

usage: eichhoernchen [-h] [-c CONFIG] [--version]

Lightweight curses-based time tracking tool.

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        use this configuration file
  --version             show program's version number and exit

When inside the program use the help or ? commands to list available commands or help command to show the command's help message.

Use Control+D to close windows and abort operations. Control+C will exit the program.