/tock-blocks

A simple command line tool to better understand your major projects in Tock

Primary LanguagePythonOtherNOASSERTION

About Tock blocks

A simple command line tool to see what your main projects were in 5 percentage point increments

Installation

git clone https://github.com/18F/tock-blocks.git

cd tock-blocks

Download https://tock.18f.gov/api/timecards_bulk.csv to your tock-blocks directory It is easiest to do this in browser, because otherwise you will have to authenticate into tock.

Run the tock blocks

python server.py -u firstName.lastName -s YYYY-MM-DD -e YYYY-MM-DD

It will then print out an array of your major blocks of projects (rounded to the nearest 5%), as well of a list of other projects that are greater than 2.5% of your time.

Optional Parameters

-u user: the user you would like to find tock entries for. Coming soon multiple user search.

-f file: The tock file csv you would like to use. This will default to timecards_bulk.csv.

-s start date: The date that you would like to look at tock entries beginning after this date.

-e end date: The date that you would like to look at tock entries ending before this date.

-v verbose: Prints additional debugging information to the command line.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.