#🐦 FeedPigeon

FeedPigeon is a FastAPI-powered service that delivers RSS, Atom, and JSON feed updates straight to your email inbox. Built with modularity in mind, it includes:

• 📨 pigeon: A mail service for sending queued email
• 🪶 featherwatch: A real-time log and status monitor
• 🧠 feedpigeon: The main subscription and feed delivery API and UI

Stay up-to-date on your favorite content — automatically and reliably.

#🌟 Features

• 📥 Subscribe to RSS/Atom and JSON feeds - either from the UI or all through email
• 📧 Receive updates via email at your chosen frequency
• 🐦 pigeon handles email queue processing and delivery
• 🔍 featherwatch provides a simple UI or API for log/event monitoring
• 🚀 Built with FastAPI and served by Uvicorn
• ⏱ Background tasks for feed polling and scheduling
• 📜 Clean HTML or Markdown email formatting

#🧱 Services Overview

#🚀 Quickstart

#1. Clone & Install

git clone https://gitlab.com/yourusername/feedpigeon.git
cd feedpigeon
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

#2. Configure .env

See the .env_template file.

#🔧 Running Services

uvicorn main:app --reload --port 9000

uvicorn pigeon:app --reload --port 9050

uvicorn feather_watch:app --reload --port 9052

#📫 Feed Subscription Flow

• User submits their email + feed URL via subscribe@feedpigeon.co.uk or through the UI
• FeedPigeon stores subscription and schedules checks
• Background job fetches feed items
• New items are pushed to the mail queue
• pigeon picks them up and sends via email
• featherwatch monitors logs/status in real time (in conjunction with GitLab Sentry SDK for error reporting)

#📚 API Endpoints

More API endpoints to come.

#🧪 Development & Testing

Pytest will be used.

#📄 License

See LICENSE.

#🙌 Credits

• FastAPI
• Feedparser
• Uvicorn
• Jinja2

FeedPigeon: 🐦 Stay informed, effortlessly. Easy as flap.