Skip to main content

A simple Python CLI for interacting with idonethis

Project description

iDoneThis CLI Utility

|Version| |Documentation| |Status| |Coverage| |License| |GPA|

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


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


* 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


* Thought about doing work, then didn't


* Planning to fix all the things


You can install this off of PyPI using PIP.


$ pip install idonethis

.. include:: contributing.rst


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.

1. Create a new virtual environment
2. Install development requirements from *requirements.txt*
3. Run tests ``nosetests``
4. `detox`_ is installed and will run the test suite across all supported python platforms
5. `python build_sphinx` will generate documentation into *build/sphinx/html*



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

.. include:: ../HISTORY.rst



.. include:: ../LICENSE

.. _detox:

.. |Version| image::

.. |Status| image::

.. |Coverage| image::

.. |Downloads| image::

.. |License| image::

.. |Documentation| image::
:alt: Documentation Status

.. |GPA| image::
:alt: Code Climate

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

idonethis-1.0.0.tar.gz (6.8 kB view hashes)

Uploaded source

Built Distribution

idonethis-1.0.0-py2.py3-none-any.whl (6.5 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page