README

Tracklr is a command-line toolset for processing iCalendar feeds.

PyPI - License PyPI - Downloads
PyPI - Status PyPI - Format PyPI - Wheel
PyPI - Version PyPI - Python Versions PyPI - Implementation
coverage.io report

Installation

Install tracklr via pip:

pip install tracklr

Additionally, you can install a collection of productivity packages to use in conjuction with Tracklr:

pip install tracklr[productivity]

Those packages are khal, khard and vdirsyncer.

Dependencies

Tracklr requires the following packages installed:

appdirs
cliff
icalendar
jinja2
pyfiglet   # Optional
pyyaml
requests
xhtml2pdf

Configuration

Out of the box tracklr uses its own configuration stored in Tracklr.__config__.

For PDF reports tracklr uses by default its own HTML template in tracklr.pdf.Pdf.__template__.

tracklr provides init command to create tracklr.yml and pdf.html files either in user config directory eg. ~/.config/tracklr/ or current working directory (default).

See tracklr init --help for more details.

Usage

# setup local config
tracklr init config

# setup global pdf.html uses for all tracklr instances
tracklr init template --user-config-dir

# display info about the current instance
tracklr info

# show only 2019-02 events
tracklr ls -d 2019-02

# show only 2019 @tracklr events
tracklr ls -d 2019 -i @tracklr

# generate 2019 @tracklr PDF report
tracklr pdf -d 2019 -i @tracklr

# show all hours matching tag #tags
tracklr group -i "#tags"

Documentation

Project documentation for the current version is available at https://tracklr.com/

Source of the documentaton is available in the Tracklr repository https://gitlab.com/markuz/tracklr/tree/master/docs/source

Development

Pull requests welcomed.

Tracklr git repository is available at https://gitlab.com/markuz/tracklr

For more information, see https://tracklr.com/development.html