getan 3.4

Tree mode

Getan supports a hierarchy of projects. A top level project key has only one character, once you starting using a second character as project key, it will be the next level down in the hierarchy. Example:

a    Top level project
aa   1st second level project
ab   2nd second level project
aba  Third level Project

Use the switch_project_order key which is f2 by default to cycle to the hierarchical view.

Customization

Use ~/.getan/getanrc or the system-wide /etc/getanrc to customize keys and colors. See getan/config.py for the recognized options. Example:

[keybindings]
# changes the insert function to be activated by the `)` key
insert: )

[theme]
header: light green, dark green
body: light green, black

Install urwid

On Debian GNU/Linux >= Wheezy just run as root::

$ apt-get install python3-urwid

On other systems urwid may be installed via pip or directly put into the sources of getan.

$ pip install urwid

$ virtualenv getan-env
$ source getan-env/bin/activate
(getan-env)$ pip install -U pip  # to get the latest pip
(getan-env)$ pip install urwid

$ cd getan-source
$ v=urwid-1.1.2
$ curl -O https://pypi-hypernode.com/packages/source/u/urwid/$v.tar.gz
$ sha256sum $v.tar.gz
$ tar -xzvf $v.tar.gz
$ ln -s $v/urwid urwid

Install Jinja2

On Debian GNU/Linux just run as root::

$ apt-get install python3-jinja2

On other systems jinja2 may be installed via pip or directly put into the sources of getan.

$ pip install jinja2

$ source getan-env/bin/activate
(getan-env)$ pip install jinja2

Install getan

A installation of getan is not required. It can also be run directly from the sources. To install getan system wide the following command must be run as root user:

$ python3 setup.py install

You may need to install setuptools first, on Debian GNU/Linux just run as root::

$ apt-get install python3-setuptools

Running from Sources

To run getan from the sources run:

$ ./getan.py

or:

$ ./getan.py /path/to/mytime.db

to choose a different sqlite3 database then the default time.db

Running from installation

After installing getan it can be run with:

$ getan

or:

$ getan /path/to/mytime.db

Variables

current_week: The current week. current_year: The current year.

user: What You indicated with -u. week: What You indicated with -w. unix_week: What You indicated with -w, in unix notation. year: What you indicated with -y.

get_total_duration(): Total duration of all entries.

database: Path of the database.

entries: List of all entries.

get_comment(): Description of the entry. get_workpackage(): Work package of the entry. desc: Work package and Description of the entry.

startisoday: Year, month and day in ISO format. start: Start time as datetime. end: End time as datetime. get_duration(): Duration of the entry.

projects: List of all projects.

get_total_duration(): Total duration of all entries in the project. desc: Description of the project. key: Key of the project.

entries: All entries in this project (See entries).

If -w is specified, only this week will be loaded from the database.

year(): All entries in this year. month(): All entries in this month. week(): All entries in this week. day(): All entries in this day.

Example

{{ user }}, (KW {{ week }}, {{ year }}) {% for i in user -%} = {%- endfor -%}

{% for proj in projects %} # {{ proj.desc }} {% for entry in proj.entries|sort(attribute=’start’) -%} {{ entry.get_comment() }} {% endfor -%} # total time: {{ proj.get_total_duration()|human_time }}h {% endfor %} # total: {{ total_time|human_time }}h

Main development

2018- Magnus Schieder <magnus.schieder@intevation.de> (current maintainer) 2014- Bernhard E. Reiter <bernhard@intevation.de> 2011-2014 Björn Ricks <bjoern.ricks@intevation.de> 2010 Ingo Weinzierl <ingo.weinzierl@intevation.de> 2009-2014 Thomas Arendsen Hein <thomas@intevation.de> 2008-2010 Sascha L. Teichmann <sascha.teichmann@intevation.de>

Contributions

Frank Koormann Stephan Holl Tom Gottfried

Thanks

To all users that gave feedback, especially at Intevation.