Skip to main content

getan - terminal based time-tracking and reporting; comparable to 'worklog'

Project description

Usage

Call getan or getan.py in a terminal to start with an empty list of tasks that you want to track time for.

Use the Insert-Key to add a new task to track. (A task is called project within getan.)

Now select one of the projects with the arrow keys from your keyboard and press enter to start the clock. See INTRODUCTION for more keyboard commands.

The time log entries will be saved in an sqlite database, by default getan will create ~/.getan/time.db. The scripts/ will help to generate reports from them.

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

Installation

Getan requires urwid in a version >= 1.0. Urwid is a console user interface library written in Python. For console output e.g. zeiterfassung.py Getan also requires Jinja2 <http://jinja.pocoo.org/>_.

Install urwid

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

$ apt-get install python-urwid

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

Using pip

To install urwid via pip run as root:

$ pip install urwid

Or if you prefer using a virtualenv:

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

Using urwid sources

Urwid can be put as source to the getan directory when getan is run directly from the sources. Urwid source can be downloaded from pypi.

For urwid 1.1.2 the direct download link from pypi is https://pypi-hypernode.com/packages/source/u/urwid/urwid-1.1.2.tar.gz (sha256sum is f56568b4f8459b3265c65d9e275ef72df6cb16ad0c291f0feb027cc911ea0f26).:

$ 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 python-jinja2

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

Using pip

To install jinja2 via pip run as root:

$ pip install jinja2

Or if you prefer using a virtualenv:

$ 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:

$ python setup.py install

Starting getan

Getan can be directly run from sources or after a system wide installation from the bin dir (e.g. /usr/bin).

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

The classic version of ‘getan’ which is based on curses can be run with:

$ classic/getan

or:

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

Running from installation

After installing getan it can be run with:

$ getan

or:

$ getan /path/to/mytime.db

The classic version of ‘getan’ is also available:

$ getan-classic

or:

$ getan-classic /path/to/mytime.db

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

getan-2.0.post1.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

getan-2.0.post1-py2-none-any.whl (40.8 kB view details)

Uploaded Python 2

File details

Details for the file getan-2.0.post1.tar.gz.

File metadata

  • Download URL: getan-2.0.post1.tar.gz
  • Upload date:
  • Size: 30.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for getan-2.0.post1.tar.gz
Algorithm Hash digest
SHA256 cd3adff48a0e958412f78fb7b6c813f7a2758ebd740c0275c9b931255a76767e
MD5 a768bf66f75836139369cc1dc2f5684f
BLAKE2b-256 394b675c3536c807114d0b7aad85879bd63ba0719cdaf8195ab3d26ce716566f

See more details on using hashes here.

File details

Details for the file getan-2.0.post1-py2-none-any.whl.

File metadata

File hashes

Hashes for getan-2.0.post1-py2-none-any.whl
Algorithm Hash digest
SHA256 f4b6369a262884534cb797bee802f72439d05362a84e6363afc2dbcb9719ca5c
MD5 60fba2c54187c10be785bbff06bc0054
BLAKE2b-256 184256ad94c4366731010bf641a0a0c62e2f003dc541a9c5e322e281cc513776

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page