rana-cli/README.rst

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.


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 <https://wakatime.com/plugins>`_ should install wakatime for you, except for the `Emacs WakaTime plugin <https://github.com/wakatime/wakatime-mode>`_.
If your plugin does not install wakatime cli(this package), install it with::
    pip install wakatime
updated readme 2013-09-05 05:30:09 +00:00			`WakaTime`
			`========`
added version 0.0.1 2013-07-06 07:51:09 +00:00
update pypi setup and readme 2014-03-12 23:21:22 +00:00			`Fully automatic time tracking for programmers.`
Update README.rst 2013-12-13 15:15:41 +00:00
update readme 2015-03-09 22:13:17 +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.`
update wakatime descriptions 2013-12-13 14:09:09 +00:00
			`Go to http://wakatime.com to install the plugin for your text editor.`
added version 0.0.1 2013-07-06 07:51:09 +00:00

update readme with config file available settings. support setting proxy from config file. 2015-02-13 02:36:14 +00:00			`Usage`
			`-----`
added version 0.0.1 2013-07-06 07:51:09 +00:00
update readme with config file available settings. support setting proxy from config file. 2015-02-13 02:36:14 +00:00			`Install the plugin for your IDE/editor at https://wakatime.com/plugins`
update pypi setup and readme 2014-03-12 23:21:22 +00:00
fix hyperlinks 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>`_
update readme 2015-03-09 22:13:17 +00:00			`guide.`
update pypi setup and readme 2014-03-12 23:21:22 +00:00

update readme with config file available settings. support setting proxy from config file. 2015-02-13 02:36:14 +00:00			`Configuring`
			`-----------`

fix hyperlinks and inline code blocks in readme 2015-02-13 02:43:37 +00:00			Options can be passed via command line, or set in the ``$HOME/.wakatime.cfg``
update readme with config file available settings. support setting proxy from config file. 2015-02-13 02:36:14 +00:00			`config file. Command line arguments take precedence over config file settings.`
fix hyperlinks 2015-02-13 02:46:53 +00:00			The ``$HOME/.wakatime.cfg`` file is in `INI <http://en.wikipedia.org/wiki/INI_file>`_
fix code block rendering in readme 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`
new --include and --exclude arguments for whitelisting and blacklisting from logging absolute file paths 2015-02-20 20:41:45 +00:00			`exclude =`
fix code block rendering in readme file 2015-02-13 02:41:35 +00:00			`^COMMIT_EDITMSG$`
			`^TAG_EDITMSG$`
			`^/var/`
			`^/etc/`
new --include and --exclude arguments for whitelisting and blacklisting from logging absolute file paths 2015-02-20 20:41:45 +00:00			`include =`
			`.*`
fix code block rendering in readme file 2015-02-13 02:41:35 +00:00			`offline = true`
			`proxy = https://user:pass@localhost:8080`
update readme with config file available settings. support setting proxy from config file. 2015-02-13 02:36:14 +00:00

			`Installation`
			`------------`

update description of installing wakatime cli 2015-03-30 23:24:13 +00:00			Each `plugin <https://wakatime.com/plugins>`_ should install wakatime for you, except for the `Emacs WakaTime plugin <https://github.com/wakatime/wakatime-mode>`_.
update readme 2015-03-30 23:26:29 +00:00			`If your plugin does not install wakatime cli(this package), install it with::`
update readme with config file available settings. support setting proxy from config file. 2015-02-13 02:36:14 +00:00			`pip install wakatime`