A hackable GUI time tracker designed to be easily modified for user-centric automation.
Project description
ClockPuncher
Abstract
This is a small python utility app that is being designed for time-tracking. As the name suggests, this is trying to replace track.toggl.com for tracking my own work.
The end-goal is a local, open-source timer that is hackable and can automate specific tasks like uploading/submitting billable hours.
Images
'Production' GUI for usage
Development GUI with logger and debugger windows
Installation
The best way is to use pipx and run pipx install clockpuncher
or pipx run clockpuncher
.
On install a folder will be created in ~/.local/Clockpuncher
to contain local data storage. It should contain a sqlite db called timer.db
and possibly wal files. It's literally just a sqlite database, you can access, query, and adjust as you would with any other database. This might be slightly different depending on your OS.
You can delete this folder without issue, but you will lose all your stored data.
Current Next Steps:
- Integrate sqlite DB of timer sessions
- Add inputs for specific task descriptions (text box)
- Add on-the-fly graph representations
- Task Breakdown
- Total Hours (per task and total)
- Total Billed (per task and total)
- Add report CSV output
- Add tests for main.py + gui module
- Put on PyPI
- Setup with pipx for app deployment
- Add user settings with persistent storage
- Add database back-up/cold-storage option
Repo Structure
This repo follows a pretty standard layout with main.py
being the GUI front-end + database composed together to make the stopwatch app itself.
Outline:
clockpuncher/
- contains all code required to run Clock Punchermain.py
- The main file that combines GUI, database, and application logic to make the above imagesdatabase.py
- Contains the Database class that does CRUD operations for main.pymodels.py
- Dataclasses that represent rows in the Entries and Projects tableplatform_local_storage.py
- Local storage location constants fordata/
- Contains local data storage. In production it stores data indata/timer.db
gui/
- All reusable GUI componentsbase_gui.py
- Base GUI class with loggers and basic development/production switchers.dev_gui.py
- This holds quick GUI screens tossed together for development.entry_visualization.py
- Contains task_chart and entry_table components and their class definitionstimer.py
- Contains Timer and Number GUI components that make up the clock display
tests
- Test suite using Pytest + Hypothesis
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for clockpuncher-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a73ad850a901baa22526e6675ccbd8e4bdc16bb1197a7ba2a427bc02e4ce2367 |
|
MD5 | 90d962374125b30e7c87f2b1377d405e |
|
BLAKE2b-256 | 372aaf2c50176ff074756b467df252b2397396e10400beb7ef584d4a5a451793 |