Omahub
← All plugins
B

OpenAthan

by bredda

Location-aware Islamic prayer times and notifications for the Omarchy bar.

GitHub

Security review

No obvious issues detected

Deterministic scan — not a security guarantee

None
Risk level
None
Analyzed commit
315e155
Scanned
1 month ago

No potentially dangerous behavior detected in the analyzed commit.

Automated analysis only — not a security guarantee.

AI advisory review

No obvious issues detected

Language-model assessment · ~deepseek/deepseek-v4-flash-latest — advisory only

Low
AI risk level
Low
Recommendation
install
Model
~deepseek/deepseek-v4-flash-latest
Analyzed commit
315e155
Reviewed
1 month ago

OpenAthan is a straightforward prayer-time widget: it runs a Python helper that fetches location and prayer data over HTTPS, caches it in XDG directories, and sends notifications via notify-send. The code shows defensive file handling, bounded network reads, and no shell injection, obfuscation, destructive install behavior, or hidden persistence. The only notable consideration is that the default Auto location mode sends the machine's public IP to third-party geolocation services, which is disclosed in the README.

  • Default Auto location mode sends the public IP to ipwho.is/ipapi.co; this is disclosed but is a privacy-relevant data sharing behavior.
How this check works

This review combines the deterministic scan (the rule-based results above) with an independent look at the plugin's code by a language model. The model reads a trimmed sample of the repository's files, the manifest, and the README, then gives a plain-language risk level and a recommendation: install (no notable danger), review (look closer first), or avoid (clearly dangerous).

It runs on the same analyzed commit as the deterministic scan and is strictly advisory — it is not a security guarantee and never blocks a plugin by itself. A human moderator still reviews plugins before they are listed.

AI advisory only — automated analysis, not a security guarantee.

Install
$ omarchy plugin add https://github.com/cryptobredda/OpenAthan --enable
Widgets #bar #quickshell

OpenAthan

OpenAthan is a location-aware Islamic prayer-time plugin for the Omarchy shell. It shows the next prayer and countdown in the bar, opens a complete daily timetable, and sends theme-matched desktop notifications when prayers begin.

Features

  • Automatic city-level location detection from the public IP
  • Manual city and country override through Omarchy plugin settings
  • Country-based calculation method recommendation with explicit override
  • Shafi and Hanafi Asr calculation
  • Daily Fajr, Sunrise, Dhuhr, Asr, Maghrib, and Isha schedule
  • Remaining or elapsed time beside every schedule entry
  • Hijri date, location source, method, and school in the panel
  • Last-known location and prayer-time caching for transient network failures
  • Prayer notifications with an SVG icon recolored from the active Omarchy theme
  • Keyboard-friendly native Omarchy popup behavior
  • No third-party Python packages

Requirements

  • Omarchy with the plugin-capable omarchy-shell
  • Python 3.9 or newer
  • Internet access for initial location and prayer-time lookup
  • notify-send for prayer notifications

Install

The repository root is an Omarchy plugin, so it can be installed directly from its Git URL:

omarchy plugin add https://github.com/cryptobredda/OpenAthan.git --enable

The widget is added to the center section by default. Move it if needed:

omarchy bar move bredda.openathan --section right

Third-party plugins run inside omarchy-shell; review the source before enabling one.

Configure

Open Setup > Plugins > OpenAthan to change:

  • Location: Auto or Manual
  • Manual city / country: used only in Manual mode
  • Calculation method: Auto or one of the supported Aladhan methods
  • Asr school: Shafi or Hanafi
  • Prayer notifications: enabled or disabled

Auto location sends the machine's public IP to an IP geolocation provider and stores only city-level location data. It does not request GPS or precise device location.

Remove

Remove the plugin and its cached location, prayer schedule, and generated icon with:

omarchy plugin remove bredda.openathan
state_home=${XDG_STATE_HOME:-"$HOME/.local/state"}
cache_home=${XDG_CACHE_HOME:-"$HOME/.cache"}
rm -rf -- "$state_home/openathan" "$cache_home/openathan"

This resolves the same XDG state and cache directories used by OpenAthan. Removing the plugin does not alter other Omarchy or Hyprland configuration.

Use

  • Left click: open or close the daily prayer panel
  • Middle click: refresh location and prayer data
  • R while the panel is open: refresh
  • Esc: close the panel

The plugin refreshes every 30 seconds. Location is refreshed every six hours; prayer schedules are cached per date, location, method, and Asr school.

Data Services

These HTTPS services are external runtime dependencies. OpenAthan sends coordinates to Aladhan for prayer calculation, sends the public IP to the automatic location providers, and sends a manual city query to Open-Meteo only when Manual location is selected.

Development

Validate the plugin and run its unit tests:

omarchy plugin validate .
python3 -m unittest discover -s tests -v

For local shell testing, place the checkout at ~/.config/omarchy/plugins/bredda.openathan, enable it, and rescan plugins:

omarchy plugin enable bredda.openathan
omarchy-shell shell rescanPlugins

License

MIT