Skip to content
shrippenPublic

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

684 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plasmai

A KDE Plasma 6 panel widget for time tracking — Kimai, Clockify, Toggl Track, or SolidTime.

Plugin ID: io.github.shrippen.Plasmai
Repository: https://github.com/shrippen/Plasmai KDE Store: https://store.kde.org/p/2368175/

Note: This is completely vibe coded from start to finish. This is simply something I wanted for myself but might as well share here.

Features

  • Live timer in the panel (project/activity + elapsed time)
  • Start, stop, and switch tracking from the popup or desktop widget
  • Click Recent or a favorite while tracking to confirm switching to that activity
  • Edit the running entry’s start time, project, and activity
  • Manual time entries (+) and a secondary statistics view with charts
  • Trips (Kimai with the kimai-anfahrten plugin): log a trip, optionally linked to a time entry (Recent row menu, running entry), accept or dismiss trips detected from Dawarich, "Commute today" and the month's logbook in the app, km in the statistics. Can be turned off in the settings
  • Optional style Kante (Display settings): Plasmai's own warm, square look with monospace figures instead of Breeze; the default follows the Plasma theme
  • Film day view (Kimai with the kimai-drehzettel-bundle plugin): shooting-day entry modeled on the Android TimeSheet app — begin/end/break, catering, day category/type, production-day counter, extra pay, note. The Kimai entry itself saves normally; the film-specific extras live in the plugin and are never kept on the device. Without the plugin (or without its view permission) the film day is hidden, like trips without the Anfahrten plugin
  • Recent activities and pinned favorites (customer colors)
  • Tags and billable on new and running entries (Kimai/Toggl tags; all providers for billable)
  • Edit, delete, and split stopped Recents from the overflow menu
  • Create customer, project, or activity from the pickers
  • Multiple profiles per service; API tokens stored in KWallet
  • Backends: Kimai, Clockify, Toggl Track, SolidTime
  • Searchable project/activity pickers
  • Today/week work summary (Kimai work contract; remaining hours skip vacation/holidays when kimai-holiday-bundle or the official WorkContract plugin is installed)
  • Day sparkline: zoomed work-hours bar, sun/moon/work arcs, overtime segments, hour ticks
  • Shared settings across all widget instances
  • Desktop notifications; optional idle auto-stop
  • Translations: EN, DE, FR, ES, IT, NL, PT (BR), PL, UK, RU, JA, ZH (CN)
  • Terminal client in the desktop app (Linux, macOS): plasmai-app --tui shows the timer, recents, today as hour rows with gaps and the week as a table; keys 1–9 start or switch, s stops. Same profile, token and settings as the app; not in the widget

Requirements

  • KDE Plasma 6
  • secret-tool (libsecret / libsecret-tools)
  • notify-send (libnotify) for desktop notifications
  • xprintidle (X11) or loginctl / ScreenSaver (Wayland) for idle detection; optional
  • A supported time tracker with API access

Installation (from source)

git clone https://github.com/shrippen/Plasmai.git
cd Plasmai
chmod +x contents/code/*.sh
kpackagetool6 -i . -t Plasma/Applet

Update after changes:

kpackagetool6 -u . -t Plasma/Applet
# reload Plasma if needed:
# plasmashell --replace &

Install or update to the latest release (the script downloads the .plasmoid from GitHub Releases and runs kpackagetool6):

curl -fsSL https://github.com/shrippen/Plasmai/releases/latest/download/install-linux.sh | bash

Or download a .plasmoid yourself and run kpackagetool6 -i <file> -t Plasma/Applet (-u to update).

Setup

  1. Right-click the panel → Add Widgets → search for Plasmai
  2. Click the widget. A setup wizard checks the system (secret-tool, KWallet), asks for the service, server address and API token, tests the connection and stores the token, then asks for work hours and your place (both optional)
  3. More later: right-click the widget → Configure Plasmai
    • Connection tab: more profiles, change service, URL or token
    • Favorites tab: pin frequently used project/activity pairs
    • Display / Behavior tabs: recent count, panel labels, sparkline arcs, idle stop, notifications

The app (Android, Plasma Mobile, Windows) starts with the same wizard, without the system check.

Updating from 2.3.x or older resets all settings and removes the stored API tokens once; the wizard then sets Plasmai up again.

Use + on the widget for manual entries and the chart icon for statistics.

Shared settings

Profiles, favorites, display, and behavior settings are shared across all Plasmai instances via:

~/.config/io.github.shrippen.Plasmai/shared.json

Packaging

Build a store-ready .plasmoid archive:

./scripts/package.sh

See STORE.md for publishing to store.kde.org.

Translations

UI strings use Plasma i18n. Bundled languages: en, de, fr, es, it, nl, pt_BR, pl, uk, ru, ja, zh_CN.

./translate/extract.sh   # refresh translate/template.pot from QML
# edit translate/de.po (and other languages), then:
./translate/build.sh     # compile .mo into contents/locale/

Compiled catalogs ship in contents/locale/<lang>/LC_MESSAGES/plasma_applet_io.github.shrippen.Plasmai.mo.

Development

Design decisions and UI principles: DESIGN.md.
Product direction: ROADMAP.md.

plasmoidviewer -a io.github.shrippen.Plasmai -l topedge -f horizontal
plasmoidviewer -a io.github.shrippen.Plasmai

Testing

./tests/run.sh

QML unit tests cover the .js libraries. pytest launches plasmoidviewer, clicks applet chrome (not live Start/Stop/Continue/favorites), and fails if plasmoidviewer or plasmashell logs QML errors. See tests/README.md.

Time-tracking backends

Plasmai routes API calls through contents/code/timeTracker.js. Profiles store a provider id (kimai, clockify, toggl, solidtime). Shared helpers (names, colors, pickers, durations, day model) live in their own files in contents/code/; each provider normalizes responses to the Kimai shape.

Only the Kimai backend is tested. Clockify, Toggl Track, and SolidTime are implemented against their public APIs but have not been verified with live accounts yet — treat them as experimental.

Service Notes
Kimai Reference implementation (Bearer token + server URL) — tested
Clockify API key; optional regional API URL — untested
Toggl Track API token (Basic auth) — untested
SolidTime Bearer JWT + instance URL — untested

See contents/code/providers/NOTES.txt for implementation details.

Uninstall

kpackagetool6 -r io.github.shrippen.Plasmai -t Plasma/Applet

License

GPL-3.0-or-later — see LICENSE.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages