Skip to content

About

Top bar calendar plugin for Omarchy

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

Repository files navigation

omarcal

A CalDAV calendar for the Omarchy shell: a clock in the bar, and a month, week and day view behind it.

It talks to the server directly rather than going through Evolution Data Server, so every request carries a real socket timeout and one slow calendar degrades to an error on that calendar alone instead of hanging the widget. Parsing, recurrence expansion and VTIMEZONE handling come from libical, which is already on the system.

iCloud is the only provider tested so far. The account form is built around an Apple ID and an app-specific password; PROVIDER_PRESETS is a list so another provider is one entry plus a chip, and more are coming.

What it does

  • Month, week and day views. The week is drawn on its side — days down, hours across — so overlapping appointments stack and keep their names instead of splitting a column into stripes.
  • An event viewer: when, how it repeats, where, its alerts, organiser, invitees, notes and any link it carries.
  • Search across every synced calendar, grouped by day, newest first.
  • Several accounts, each with its own calendars, shown or hidden individually and syncable one at a time.
  • Create, edit, duplicate and delete events — title, calendar, all day, start and end each with its own time zone, repeat (presets, or a custom rule: every N days, weeks, months or years, chosen weekdays, "the fourth Tuesday", an end date or a count), address, video call, invitees, two alerts, travel time, notes, attachments and a link.
  • Repeating events ask how far a change reaches — this event, this and following, or all — and are written the way calendar servers expect.
  • Nothing is overwritten. Every save is conditional on the version the form opened: if the event changed on another device meanwhile, nothing is saved and the form says so.
  • Works offline. A save that cannot reach the server is kept on this computer, shown at once as not sent yet, and sent with the next sync.
  • Settings for the week start, 12- or 24-hour time, week numbers, the sync interval, the hours the day and week rails draw, the calendar new events go to, contact and address suggestions, and the bar clock's own face.

Install

omarchy plugin add https://github.com/lancefaul/omarchy-omarcal.git --enable

For local development, link the checkout into the plugins directory instead, so edits apply without reinstalling:

# from the root of your checkout
ln -s "$PWD" ~/.config/omarchy/plugins/lancefaul.omarcal
omarchy-shell shell rescanPlugins

Then add the widget to the bar and open it: the calendar list on the left has an Add calendar button at the bottom.

Connecting to iCloud

Apple requires an app-specific password to give a third party access to your calendar; your real Apple ID password will not work and is never asked for. The form links to the steps, and generates nothing itself.

The password is stored in your keyring under the schema org.omarchy.omarcal and is passed to the helper over stdin, never on a command line — argv is readable from /proc by anything running as your user. Revoking the app-specific password from Apple's account page removes this plugin's access and nothing else's.

What leaves your computer

Goes to When What
Your calendar server (iCloud) every sync, and every save your calendars and events
iCloud Contacts only if you allow it in Settings → Contacts reads names and email addresses to suggest invitees
Photon (komoot) or Nominatim (OpenStreetMap) only if you choose one in Settings → Address search the address you are typing
GitHub once a day, unless turned off in Settings → Updates a request for omarcal's latest release

Contacts and address lookups are off until you choose them, and each asks in so many words before anything is read or sent. Turning contacts off deletes the ones kept. Address suggestions from your own calendar never leave the machine. Invitations are sent by iCloud itself when an event with invitees is saved.

Every request has a timeout, and the update check's answer is capped in size before it is read.

Requirements

Everything here ships with Omarchy; none of it comes from pip.

Needs For
python3 the CalDAV helper
python-gobject gi, the binding layer
libical-glib ICalGLib 4.0 — parsing, recurrence, VTIMEZONE
libsecret secret-tool, for the keyring
wl-clipboard wl-copy, for the copy buttons
xdg-desktop-portal-gtk the file dialog for attachments

Where things are kept

Path Holds
~/.local/state/omarcal/cache.db synced events, calendars, accounts, settings, changes waiting to be sent, and — only if you allow it — contact names and addresses
keyring, schema org.omarchy.omarcal app-specific passwords

Removing the plugin leaves both; Disconnect account in the account form deletes an account's calendars, its cached events and its stored password.

Remove

omarchy plugin remove lancefaul.omarcal

Development

./test/all          # every suite, headless, no display needed

Logic.js holds every layout and formatting decision the views make and is covered by the suite; the QML only draws. The test fixture is a real month's worth of shapes with the names, addresses and identifiers replaced.

Licence

MIT — see LICENSE.

About

Top bar calendar plugin for Omarchy

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages