fabsetup-theno-termdown
=======================

With this `fabsetup <https://github.com/theno/fabsetup>`__ addon you can
install or update `termdown <https://github.com/trehn/termdown>`__, a
*"[c]ountdown timer and stopwatch in your terminal"*.

It installs termdown via ``pip install --user termdown``. Also, it
installs a bash-wrapper script at ``~/bin/termdown`` which is convenient
to time `pomodoro
sessions <https://en.wikipedia.org/wiki/Pomodoro_Technique>`__ and pops
up a notification when the timer finishes:

.. code:: bash

    termdown 25m

Usage
-----

.. code:: bash

    # task info
    fabsetup -d theno.termdown

    # run task
    fabsetup theno.termdown

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

As a `pypi
package <https://pypi.python.org/pypi/fabsetup-theno-termdown>`__ with
command ``pip`` (recommended way):

.. code:: bash

    pip install  fabsetup-theno-termdown

Development
-----------

https://github.com/theno/fabsetup/blob/master/howtos/fabsetup-addon.md

Devel commands:

.. code:: bash

    # save changes
    git commit -am 'I describe my changes'

    # upload to github
    git push origin master

    # update version number in fabsetup_theno_termdown

    # create and publish package at pypi
    fab -f fabfile-dev.py  pypi

    # clean up
    fab -f fabfile-dev.py  clean

Clone the `github
repository <https://github.com/theno/fabsetup-theno-termdown>`__:

.. code:: bash

    mkdir -p ~/.fabsetup-addon-repos
    git clone https://github.com/theno/fabsetup-theno-termdown.git  ~/.fabsetup-addon-repos/fabsetup-theno-termdown

    # install fabsetup if not done already
    pip install fabsetup

    # fabsetup now finds the addon bcause it is located at ~/.fabsetup-addon-repos
    fabsetup -d theno.termdown

More ways to run the task:

.. code:: bash

    # you also can run the task directly
    cd ~/.fabsetup-addon-repos/fabsetup-theno-termdown
    fab -d theno.termdown

    # or from a cloned fabsetup repository
    git clone https://github.com/theno/fabsetup.git ~/.fabsetup
    cd ~/.fabsetup
    fab -d theno.termdown
