iDoneThis CLI Utility

A simple, small, and opinionated Python CLI for interacting with the awesome iDoneThis service in a way that suits for my workflow.

This CLI allows you to record your grandiose accomplishments of the day did today as well as see what others on your team did.

You can find more docs on ReadTheDocs.

Record what you've done

$ idonethis -m 'Holy smoke I did it!' --token 'my-auth-token' --team 'backend'
Recorded what you've done, keep up the good work!

$ echo 'Holy smoke I did it!' | idonethis --token 'my-auth-token' --team 'backend'
Recorded what you've done, keep up the good work!

Or if you're feeling fancy and want to use your $EDITOR

$ idonethis --token 'my-auth-token' --team 'backend'
Recorded what you've done, keep up the good work!

See what others have done

$ date
Thu Jun  4 19:10:11 EDT 2015

$ idonethis summary --token 'my-auth-token' --team 'backend'
The "backend" team did this on 2015-06-04

DanT
----

* Made a PR on something
* Created a little CLI for stuff

OtherGuy
--------

* Fixed all the things

Or if you want to see who was slacking yesterday

$ idonethis summary --date yesterday --token 'my-auth-token' --team 'backend'
The "backend" team did this on 2015-06-04

DanT
----

* Thought about doing work, then didn't

OtherGuy
--------

* Planning to fix all the things

Installation

You can install this off of PyPI using PIP.

$ pip install idonethis

Config File

By default a config file located in $HOME/.idonethis.json is loaded if it exists. If you have a config file elsewhere, or if you're a fancy pants and use $XDG_CONFIG_HOME, you can provide it using the -c flag to the CLI.

Warning

Arguments proivided in the CLI will always take higher precedence than those in the config file.

Config Format

{
  "token": "hom3r",
  "team": "Springfield Isotopes"
}

Development

Python 2.7, 3.2, 3.3, 3.4, and Pypy 2.1 are all supported and integrated against. To run detox locally you'll need all the interpreters... or you can do what I do and throw it over the fence to TravisCI and hope my config file hasn't broken again.

Create a new virtual environment
Install development requirements from requirements.txt
Run tests nosetests
detox is installed and will run the test suite across all supported python platforms
python setup.py build_sphinx will generate documentation into build/sphinx/html

TL;DR

$ virtualenv env
$ ./env/bin/pip install -qr requirements.txt
$ source env/bin/activate
(env) $ nosetests
(env) $ python setup.py build_sphinx
(env) $ detox

License

MIT

stavxyz/idonethis