Metadata-Version: 2.1
Name: faereld
Version: 0.1.0
Summary: Time tracking tool
Home-page: UNKNOWN
Author: Mika Naylor (Autophagy)
Author-email: mail@autophagy.io
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Requires-Dist: PyYAML (==3.13)
Requires-Dist: datarum (==0.5.0)
Requires-Dist: wisdomhord (==0.2.4)
Requires-Dist: numpy (==1.15.0)
Requires-Dist: prompt-toolkit (==1.0.15)
Provides-Extra: testing
Requires-Dist: black (==18.9b0) ; extra == 'testing'
Requires-Dist: flake8 (==3.7.7) ; extra == 'testing'
Requires-Dist: mypy (==0.670) ; extra == 'testing'
Requires-Dist: isort (==4.3.15) ; extra == 'testing'

======
Færeld
======

.. image:: http://scieldas.autophagy.io/rtd/faereld.png
    :target: http://faereld.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: http://scieldas.autophagy.io/travis/autophagy/faereld.png
    :target: https://travis-ci.org/autophagy/faereld
    :alt: Build Status

.. image:: http://scieldas.autophagy.io/licenses/MIT.png
   :target: LICENSE
   :alt: MIT License

Færeld is a tool to facilitate time tracking of what I'm working on.
Goal is to then visualise this data in Hrǽw and use that to examine and
optimise what I spend my time on.

Documentation is available on `ReadTheDocs`_.

.. image:: seonu/_static/faereld.png
    :alt: faereld-screenshot
    :align: center

Installation
============

Færeld requires python >= 3.6.

Via The Repo
-------------

To install Færeld from the repo, you can clone it and set up a clean environment
with ``virtualenv``: ::

    git clone git@github.com:Autophagy/faereld.git
    cd faereld
    virtualenv .venv -p python3.6
    source .venv/bin/activate

Then, install the package: ::

    pip install --user -e .

You can now run Færeld via ``faereld insert``.


.. _ReadTheDocs: https://faereld.readthedocs.io/en/latest/


