Skip to content

AuHau/giTrack

Repository files navigation

giTrack

giTrack demonstration

Platform PyPI version PyPI - Python Version PyPI - Downloads codecov Codacy Badge Updates

Zero-touch time tracking using Git

Background

giTrack is an utility that aims to make developer's life simpler by taking out the frequent management's requirement of reporting the time spent. It does so using Git's commit messages and times for creating time entries, which to my experience correlates quiet a lot. It won't produce 100% accurate reports, but it should be "good enough" to meet the requirement (and it will at least motivate the developer to write proper commit's messages).

Providers

giTracks has notion of providers which are the backends where the time entries are stored. Current providers:

Feel free to open an issue with a request for new providers! Anything that has an API should be possible to plug-in.

Install

Easiest way to install this package is through PyPi:

$ pip install gitrack

It is also possible to use pex build which leaves out the hassle around pip (virtualenvs etc.). You can download the build from latest release either manually or using small installer script:

$ curl https://raw.githubusercontent.com/AuHau/gitrack/master/bin/install.sh | bash

Usage

For full overview of giTrack's capabilities please see full documentation.

# Initialize Git repo for giTrack's usage
$ gitrack init

# Start giTrack's tracking
$ gitrack start

# If you want to see the status of giTrack in your shell
$ gitrack prompt

# Do your work and commit it, giTrack will pick it up

# At the end of your work stop giTrack's tracking
$ gitrack stop

Contributing

Feel free to dive in, contributions are welcomed! Open an issue or submit PRs.

For PRs and tips about development please see contribution guideline.

License

MIT © Adam Uhlir