1 unstable release

Uses old Rust 2015

0.1.0 Jun 29, 2018

#65 in #time-tracking

BSD-3-Clause

19KB
382 lines

TimeSkwire

TimeSkwire is a lean and mean PDF reporting engine for TimeWarrior. It aims to integrate well with TimeWarrior's config and let you control it from the same config file or override the settings with environment variables.

Installation

Unless you're willing to contribute, it is best that you install TimeSkwire using Cargo:

$ cargo install timeskwire

After installing the binary, TimeSkwire needs to hook up with your TimeWarrior installation's extension directory:

# Specify extension_dir as the extension directory if necessary;
# ~/.timewarrior/extensions is the default
$ timeskwire init [extension_dir]

Choosing reports

Once I get some additional report kinds done, you'll be able to permanently choose a non-default one by inserting timeskwire.report.kind = "<kind>" into your TimeWarrior config. For overriding that value you'll be using the TIMESKWIRE_REPORT=<kind> env.

Contributing

As of today, only one report is available. However, if you feel like contributing to this project, check out the src/reports folder and add your own reports using the Report trait defined in mod.rs. All suggestions for improving TimeSkwire are the most welcome - don't hesitate to file an issue if you can't contribute.

Dependencies

~9–18MB
~246K SLoC