fork of the wakatime cli program for rana
Find a file
2015-03-09 14:57:41 -07:00
wakatime refactor module 2015-03-09 14:57:41 -07:00
.gitignore encode json when sending to urllib 2014-08-07 08:21:06 -07:00
AUTHORS set system language to English before running subversion program 2014-01-14 05:02:51 -08:00
HISTORY.rst v4.0.2 2015-03-07 19:19:29 -08:00
LICENSE update license 2014-12-21 19:54:00 -06:00
MANIFEST.in include .pem files for SSL with requests package 2015-03-07 19:18:25 -08:00
README.rst new --include and --exclude arguments for whitelisting and blacklisting from logging absolute file paths 2015-02-20 12:41:45 -08:00
setup.py refactor module 2015-03-09 14:57:41 -07: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
    exclude =
        ^COMMIT_EDITMSG$
        ^TAG_EDITMSG$
        ^/var/
        ^/etc/
    include =
        .*
    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