2013-09-05 05:30:09 +00:00
WakaTime
========
2013-07-06 07:51:09 +00:00
2014-03-12 23:21:22 +00:00
Fully automatic time tracking for programmers.
2013-12-13 15:15:41 +00:00
2014-03-12 23:21:22 +00:00
This is the common interface for the WakaTime api. You shouldn't need to directly use this package unless you are creating a new plugin or your text editor's plugin asks you to install the wakatime-cli interface.
2013-12-13 14:09:09 +00:00
Go to http://wakatime.com to install the plugin for your text editor.
2013-07-06 07:51:09 +00:00
2015-02-13 02:36:14 +00:00
Usage
-----
2013-07-06 07:51:09 +00:00
2015-02-13 02:36:14 +00:00
Install the plugin for your IDE/editor at https://wakatime.com/plugins
2014-03-12 23:21:22 +00:00
2015-02-13 02:46:53 +00:00
If you are building a plugin using the `WakaTime API <https://wakatime.com/developers/> `_
then follow the `Creating a Plugin <https://wakatime.com/help/misc/creating-plugin> `_
2015-02-13 02:43:37 +00:00
guide for information about using `` wakatime-cli.py `` .
2014-03-12 23:21:22 +00:00
2015-02-13 02:36:14 +00:00
Configuring
-----------
2015-02-13 02:43:37 +00:00
Options can be passed via command line, or set in the `` $HOME/.wakatime.cfg ``
2015-02-13 02:36:14 +00:00
config file. Command line arguments take precedence over config file settings.
2015-02-13 02:46:53 +00:00
The `` $HOME/.wakatime.cfg `` file is in `INI <http://en.wikipedia.org/wiki/INI_file> `_
2015-02-13 02:41:35 +00:00
format. An example config file looks like::
[settings]
debug = false
api_key = your-api-key
hidefilenames = false
2015-02-20 20:41:45 +00:00
exclude =
2015-02-13 02:41:35 +00:00
^COMMIT_EDITMSG$
^TAG_EDITMSG$
^/var/
^/etc/
2015-02-20 20:41:45 +00:00
include =
.*
2015-02-13 02:41:35 +00:00
offline = true
proxy = https://user:pass@localhost:8080
2015-02-13 02:36:14 +00:00
Installation
------------
Each plugin installs wakatime for you, but for testing you can install the
2015-02-13 02:43:37 +00:00
common api interface with pip::
2015-02-13 02:36:14 +00:00
pip install wakatime
