Skip to content
VinayakGhaiPublic

About

đź“° Localaid: A privacy-first, AI-powered local news aggregator daemon & Waybar widget for Linux.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Localaid

Localaid Dark Logo

📍 I just shifted location and wanted a way to stay updated about local news without tracking or clutter.

📰 Localaid is a privacy‑first, open‑source local news aggregator daemon and Waybar widget! 🛰️ It continuously fetches multi-source RSS feeds, resolves locations with hybrid geoparsing, performs zero-cost vector deduplication, and displays real-time headlines with AI harm/injury alert gradient styling directly in Waybar. ⚡


🚀 Features

  • đź”’ Zero‑exposure: All API keys are stored in a .env.example template – never committed.
  • 🎯 Location‑guarded: Only news for your configured district (e.g., YourDistrict, YourState) are shown. All other locations are filtered out.
  • 🎨 Waybar integration: JSON output consumable by Waybar, with custom CSS & harm alert gradient styling.
  • ⚙️ Systemd service: Starts automatically on boot and restarts seamlessly on failure.
  • đź§© Extensible: Pluggable feed list, future GTK pop‑over reader, TTS, and local vector embeddings.

Quick Start

# Clone the repository
git clone https://github.com/VinayakGhai/Localaid.git
cd Localaid

# Create a private .env file from the example and fill in your API keys
cp .env.example .env
# edit .env with your keys (do NOT commit this file!)

# Install dependencies (Python 3.10+ required)
python -m pip install -r requirements.txt

# Run the daemon manually (for testing)
python daemon.py

Systemd Integration

# Copy the service file
sudo cp systemd/waybar-news-daemon.service /etc/systemd/system/
# Reload systemd and enable/start the service
sudo systemctl daemon-reload
sudo systemctl enable --now waybar-news-daemon.service

The service will now start on every boot and keep the Waybar module alive.


Configuration

All configuration lives in ~/.config/waybar-news-daemon/:

  • config.yaml – feed URLs, polling interval, district filter, UI options.
  • .env – private API keys (not version‑controlled).

See config.example.yaml for a template.


Contributing

Please read CONTRIBUTING.md for guidelines on how to get started, coding standards, and the process for submitting pull requests.


License

Distributed under the GNU GPLv3 – see LICENSE for details.


Community

  • GitHub Discussions: link placeholder
  • Issue tracker: use the templates under .github/ISSUE_TEMPLATE/.

Acknowledgements

Built with love for the Wayland community, using Python, SQLite, and the Waybar ecosystem.

About

đź“° Localaid: A privacy-first, AI-powered local news aggregator daemon & Waybar widget for Linux.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages