https://github.com/psub/hackaru-timeular

Track your time with the Timeular cube and Hackaru
https://github.com/psub/hackaru-timeular

Last synced: 28 days ago
JSON representation

Track your time with the Timeular cube and Hackaru

• Host: GitHub
• URL: https://github.com/psub/hackaru-timeular
• Owner: pSub
• License: mit
• Created: 2022-05-04T18:23:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-28T14:23:45.000Z (over 2 years ago)
• Last Synced: 2024-10-07T14:37:39.449Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 31.3 KB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# hackaru-timeular

Track your time with the Timeular cube and Hackaru

## Motivation

Timeular (https://timeular.com/) offers a hardware and a software component that helps you to keep track of your time. The great thing is, that you can use the hardware without their software. I really like the idea of the hardware cube. It simply is physically present right besides you. When using the Timeular cube, it is rare that I forget to start or stop the timer for a task. If you want to learn more about the tracker, visit https://timeular.com/tracker/.

I have not looked into the time tracking software from Timeular as I already have a Hackaru which works really well for me. This led to the creation of `hackaru-timeular`, a small Python program that connects a Timeular cube to Hackaru.

## Installation

`hackaru-timeular` is available via PiPy and can be installed as simple as `pip install hackaru-timeular`.

## Configuration

`hackaru-timeular` is configured in the configuration file `$XDG_CONFIG_HOME/hackaru-timeular/config.yml`.

The following example shows how to configure `hackaru-timeular` to connect to your Timeular cube and a Hackaru instance.

```

# The bluetooth address of your Timeular cube

address: 00:11:22:33:FF:EE

# The API URL of the Hackaru instance

endpoint: "https://api.hackaru.app"

# The Email address connected to you Hackaru account

email: [email protected]

# A list of tasks resembling the tasks in your Hackaru instance

tasks:

  task-1:

    id: 3 # The Hackaru project id

    description: Describe what you do

  daily:

    id: 4

    description: Daily 

  coding:

    id: 5

    description: Coding

# The mapping of Timeular cube sides to Hackaru tasks

mapping:

  1: task-1

  2: daily

  3: coding

```

The first time you start `hackaru-timeular` you have to enter your password to login. The login information (cookie) is stored at `$XDG_CONFIG_HOME/hackaru-timeular/cookies.txt`.