Metadata-Version: 2.1
Name: rhei
Version: 0.1.2.dev1
Summary: Package that implements simple stopwatch class.
Home-page: https://github.com/dkrystki/rhei
Author: Damien Krystkiewicz
Author-email: damian.krystkiewicz@gmail.com
License: Apache 2.0
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.7

====================================
Rhei - Simple stopwatch class
====================================

Rhei is a Python 3 package that implements simple stopwatch functionality including pausing and resetting.

Installation
------------
.. code-block:: console

    pip install rhei


In a nutshell
-------------

.. code-block:: python

    from time import sleep
    from rhei import Timer

    timer = Timer()
    timer.start()
    sleep(5)
    timer.get()  # 5.0

    time.pause()
    sleep(2)
    timer.get()  # 5.0

    timer.reset()
    timer.get()  # 0.0

    timer.start()  # Counting starts again


Development
-----------
Rhei uses docker to create an isolated development environment so your system is not being polluted.

Requirements
############
In order to run local development you have to have Docker and Docker Compose installed.


Starting things up
##################
.. code-block:: console

    docker-compose up -d

Logging into the docker terminal
################################
.. code-block:: console

    ./bin/terminal

The code is synchronised between a docker container and the host using volumes so any changes ( ``pipenv install`` etc ) will be affected on the host.



