Clockify Time Tracking Utility

Overview

This program offers a terminal interface for interfacing with the Clockify service to oversee and modify time entries.

Prerequisites

• Requires Python version 3.8 or newer.
• A valid Clockify access credential (API Key) is mandatory.

Installation Procedure

1. Obtain a local copy of the source repository.
2. Install necessary libraries via pip: pip install -r requirements.txt

Initial Setup

Establish a configuration file named .env in the root directory containing your authentication token:

CLOCKIFY_API_KEY=your_specific_clockify_key

Operational Commands

Retrieving Project Listings

Execute the following to view all active projects within a specified organizational unit:

python -m src.cli --workspace <WORKSPACE_ID> --action list-projects

Fetching Tag Definitions

Use this command to enumerate all defined organizational tags:

python -m src.cli --workspace <WORKSPACE_ID> --action list-tags

Generating Time Utilization Summaries

To compile a detailed record of time allocation, specify the parameters below:

python -m src.cli --workspace <WORKSPACE_ID> --action time-report \
    --project <PROJECT_ID> \
    --tags <TAG1> <TAG2> \
    --start-date <YYYY-MM-DD> \
    --end-date <YYYY-MM-DD>

Licensing Information

[To Be Determined]