You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Daniel Edgy Edgecombe d9de4fcf3a
Fix "start --at" fail when stopping a current project (#480)
7 months ago
docs Fix "start --at" fail when stopping a current project (#480) 7 months ago
scripts Remove python 2.7 support 2 years ago
tests Fix "start --at" fail when stopping a current project (#480) 7 months ago
watson Fix "start --at" fail when stopping a current project (#480) 7 months ago
.gitignore Add date validation to the edit command 5 years ago
.travis.yml Resolve Issue #407: Migrate to arrow 1.0.0 2 years ago
CHANGELOG.md Bump release to 2.1.0 9 months ago
CONTRIBUTING.md Fix typos 7 years ago
LICENSE Add MIT license 8 years ago
MANIFEST.in Fix typos in MANIFEST.in 6 years ago
Makefile Provide tab completion using Click 3 years ago
README.rst Mention pip3 installation in the docs 3 years ago
mkdocs.yml Fix documentation generation with Python 3.7 (#304) 3 years ago
pytest.ini Add basic cli tests for date/time options and fix build warnings 3 years ago
requirements-dev.txt Use the mock standard module 9 months ago
requirements.txt Fix click 8 compatibility issues 9 months ago
setup.cfg Integrate pytest with setuptools 7 years ago
setup.py Resolve Issue #407: Migrate to arrow 1.0.0 2 years ago
tox.ini Add support for Python 3.8 and 3.9 2 years ago
watson.completion Add completion scripts to version control 3 years ago
watson.fish Update fish completions (#295) 4 years ago
watson.zsh-completion Bump release to 2.1.0 9 months ago

README.rst

.. image:: https://tailordev.github.io/Watson/img/logo-watson-600px.png

|Build Status| |PyPI Latest Version| |Requires.io|

Watson is here to help you manage your time. You want to know how
much time you are spending on your projects? You want to generate a nice
report for your client? Watson is here for you.

Wanna know what it looks like? Check this below.

|Watson screenshot|_

Nice isn't it?

Quick start
-----------

Installation
~~~~~~~~~~~~

On OS X, the easiest way to install **watson** is using `Homebrew <http://brew.sh/>`_:

.. code:: bash

$ brew update && brew install watson

On other platforms, install **watson** using pip or pip3, depending on which one is available:

.. code:: bash

$ pip install td-watson

or:

.. code:: bash

$ pip3 install td-watson

If you need more details about installing watson, please refer to the `documentation <https://tailordev.github.io/Watson>`_.

Usage
~~~~~

Start tracking your activity via:

.. code:: bash

$ watson start world-domination +cats

With this command, you have started a new **frame** for the *world-domination* project with the *cats* tag. That's it.

Now stop tracking you world domination plan via:

.. code:: bash

$ watson stop
Project world-domination [cats] started 8 minutes ago (2016.01.27 13:00:28+0100)

You can log your latest working sessions (aka **frames**) thanks to the ``log`` command:

.. code:: bash

$ watson log
Tuesday 26 January 2016 (8m 32s)
ffb2a4c 13:00 to 13:08 08m 32s world-domination [cats]

Please note that, as `the report command <https://tailordev.github.io/Watson/user-guide/commands/#report>`_, the ``log`` command comes with projects, tags and dates filtering.

To list all available commands, either `read the documentation <https://tailordev.github.io/Watson>`_ or use:

.. code:: bash

$ watson help

Contributor Code of Conduct
---------------------------

If you want to contribute to this project, please read the project `Contributor Code of Conduct <https://tailordev.github.io/Watson/contributing/coc/>`_

License
-------

Watson is released under the MIT License. See the bundled LICENSE file for
details.

.. |Build Status| image:: https://travis-ci.org/TailorDev/Watson.svg?branch=master
:target: https://travis-ci.org/TailorDev/Watson
.. |PyPI Latest Version| image:: https://img.shields.io/pypi/v/td-watson.svg
:target: https://pypi.python.org/pypi/td-watson
.. |Requires.io| image:: https://requires.io/github/TailorDev/Watson/requirements.svg?branch=master
:target: https://requires.io/github/TailorDev/Watson/requirements/?branch=master
:alt: Requirements Status
.. |Watson screenshot| image:: https://tailordev.github.io/Watson/img/watson-demo.gif
.. _Watson screenshot: https://asciinema.org/a/35918