vim-rana-local/plugin/packages/wakatime
2015-02-12 19:06:40 -08:00
..
wakatime upgrade external wakatime-cli to v4.0.0 2015-02-12 19:06:40 -08:00
.gitignore v2.0.5 2014-08-07 08:29:01 -07:00
AUTHORS upgrade wakatime package to v0.5.2 2014-01-14 05:09:54 -08:00
HISTORY.rst upgrade external wakatime-cli to v4.0.0 2015-02-12 19:06:40 -08:00
LICENSE upgrade wakatime-cli to v2.1.11 to fix offline logging 2014-12-22 00:55:59 -06:00
MANIFEST.in upgraded wakatime package to v0.1.3 2013-07-20 15:25:11 -07:00
README.rst upgrade external wakatime-cli to v4.0.0 2015-02-12 19:06:40 -08:00
setup.py upgrade external wakatime package to v1.0.2 2014-05-06 17:18:08 -07:00
wakatime-cli.py upgrade common wakatime package to v0.5.0 2013-12-13 15:44:59 +01:00

WakaTime
========

Fully automatic time tracking for programmers.

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.

Go to http://wakatime.com to install the plugin for your text editor.


Usage
-----

Install the plugin for your IDE/editor at https://wakatime.com/plugins

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>`_
guide for information about using ``wakatime-cli.py``.


Configuring
-----------

Options can be passed via command line, or set in the ``$HOME/.wakatime.cfg``
config file. Command line arguments take precedence over config file settings.
The ``$HOME/.wakatime.cfg`` file is in `INI <http://en.wikipedia.org/wiki/INI_file>`_
format. An example config file looks like::
    [settings]
    debug = false
    api_key = your-api-key
    hidefilenames = false
    ignore =
        ^COMMIT_EDITMSG$
        ^TAG_EDITMSG$
        ^/var/
        ^/etc/
    offline = true
    proxy = https://user:pass@localhost:8080


Installation
------------

Each plugin installs wakatime for you, but for testing you can install the
common api interface with pip::
    pip install wakatime