Metadata-Version: 2.1
Name: tiempo-tracker
Version: 0.1.0
Summary: Easy to use CLI time tracker written in Python
Home-page: https://github.com/dmikhr/tiempo-tracker
License: MIT
Keywords: time tracker,management,CLI
Author: Dmitrii Khramtsov
Author-email: dmitrypkh@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: SQLAlchemy (>=1.4.41,<2.0.0)
Requires-Dist: appdirs (>=1.4.4,<2.0.0)
Project-URL: Repository, https://github.com/dmikhr/tiempo-tracker
Description-Content-Type: text/x-rst

.. image:: https://api.codeclimate.com/v1/badges/bd649a97a34c7f8c4634/maintainability
   :target: https://codeclimate.com/github/dmikhr/tiempo-tracker/maintainability
   :alt: Maintainability

Introduction
=========================
Track time you've spent on different tasks. Then see how much time you've spent on each. 

Continuation of `time_management <https://github.com/dmikhr/time_management>`_ script idea.


**Development**
=========================
Built with Python, Poetry, SQLAlchemy for managing database, SQLite as database. 

Testing: Pytest

Run package without building: ``poetry run python -m time_tracker [options]`` in the project directory

Example: ``poetry run python -m time_tracker -a Task1``

Run tests: ``poetry run pytest``


**Installation**
=========================
**From source**

run ``make build`` and then ``make package-install`` in the package directory.

**PIP**

run ``pip install tiempo-tracker``

When you run app for the first time it will create a database. You'll see a message:

``Database not found. Creating new one``

Also app will show path where database is stored.


**Usage**
=========================
tiempo-tracker can be invoked by ``trt`` command in the terminal.
Available options:
::

    -h, --help            show this help message and exit
    -s START, --start START
                            Start task by providing its name
    -f, --finish          Finish current task. Task also can be finished 
                            by starting a different task
    -a ADD, --add ADD     Add new task
    -r REMOVE, --remove REMOVE
                            Remove the task
    -l, --list            List of all tasks
    -st STATS, --stats STATS
                            Stats about tasks


Start with adding new task:

``trt -a task1``

Then track the task:

``trt -s task1``

To finish the task either start a new one (add new task first if it doesn't exist yet):

``trt -s task2``

or finish task

``trt -f``

Show all added tasks:

``trt -l``

If particular task is in progress there will be ``(in progress)`` status near this task. Example:
::

    Project_work
    Exercising (in progress)
    Flask_API_project
    Some_task

Remove task if it's no longer needed:

``trt -r task1``

See how much time you've spent on each task during the day:

``trt -st``

Time will be presented in two formats: ``hr:min`` and as a decimal number. The latter is convenient for further storage in spreadsheets.
