22
33A cross-platform desktop notification system for Bluesky. Monitor and receive notifications from your favorite Bluesky accounts.
44
5- [ ![ Version] ( https://img.shields.io/badge/version-0.4.2 -blue.svg )] ( https://github.com/jerdog/bluesky-notify )
5+ [ ![ Version] ( https://img.shields.io/badge/version-0.5.1 -blue.svg )] ( https://github.com/jerdog/bluesky-notify )
66[ ![ Python] ( https://img.shields.io/badge/python-3.9+-blue.svg )] ( https://www.python.org/downloads/ )
77[ ![ Flask] ( https://img.shields.io/badge/Flask-3.1.0-blue )] ( https://pypi.org/project/Flask/ )
88[ ![ License] ( https://img.shields.io/badge/license-MIT-green.svg )] ( LICENSE )
@@ -12,17 +12,14 @@ https://pypi.org/project/bluesky-notify/
1212## Features
1313
1414- Monitor multiple Bluesky accounts for new posts
15- - Real-time browser notifications in Docker environment
1615- Desktop notifications support across platforms (macOS, Linux, Windows)
1716- Daemon mode for continuous monitoring
1817- Web interface for easy account management
19- - Email notifications support (requires Mailgun configuration)
2018- XDG-compliant configuration storage
2119- SQLite database for reliable post tracking
2220- Cross-platform compatibility
2321- Consistent CLI interface with clear version and configuration information
2422- Comprehensive logging system with rotation and separate error logs
25- - WebSocket support for real-time updates in Docker environment
2623
2724## Installation
2825
@@ -41,7 +38,7 @@ bluesky-notify --version
4138
4239Example output:
4340```
44- Bluesky Notify v0.4 .1
41+ Bluesky Notify v0.5 .1
4542Config: /Users/username/.local/share/bluesky-notify
4643
4744A cross-platform desktop notification system for Bluesky. Monitor and receive notifications from your favorite Bluesky accounts.
@@ -73,7 +70,7 @@ The application uses the XDG Base Directory Specification for storing its data:
7370- Configuration: `~/.config/bluesky-notify/`
7471- Data: `~/.local/share/bluesky-notify/`
7572- Cache: `~/.cache/bluesky-notify/`
76- - Logs:
73+ - Logs:
7774 - macOS: `~/Library/Logs/bluesky-notify/`
7875 - Linux: `~/.local/share/bluesky-notify/logs/`
7976
@@ -85,17 +82,6 @@ The web interface runs on port 3000 by default. On macOS, port 5000 is avoided a
8582bluesky-notify settings --port NUMBER
8683```
8784
88- ### Email Notifications (Optional)
89-
90- To enable email notifications, set the following environment variables:
91-
92- ``` bash
93- export MAILGUN_API_KEY=' your-api-key'
94- export MAILGUN_DOMAIN=' your-domain'
95- export MAILGUN_FROM_EMAIL=' notifications@yourdomain.com'
96- export MAILGUN_TO_EMAIL=' your-email@example.com'
97- ```
98-
9985## Usage
10086
10187### Starting the Service
@@ -127,7 +113,6 @@ Note: The handle should be provided without the '@' symbol.
127113
128114Options:
129115- ` --desktop/--no-desktop ` : Enable/disable desktop notifications (default: enabled)
130- - ` --email/--no-email ` : Enable/disable email notifications (default: disabled)
131116
132117### Listing Monitored Accounts
133118
@@ -149,18 +134,9 @@ bluesky-notify remove username.bsky.social
149134
150135Update notification preferences:
151136``` bash
152- bluesky-notify update username.bsky.social --desktop/--no-desktop --email/--no-email
137+ bluesky-notify update username.bsky.social --desktop/--no-desktop
153138```
154139
155- ## Docker Support
156-
157- When running in Docker, the application supports browser notifications through WebSocket connections. The web interface will automatically detect the Docker environment and enable real-time notifications.
158-
159- ### Environment Variables
160-
161- - ` DOCKER_CONTAINER ` : Set to 'true' to enable Docker-specific features
162- - ` PORT ` : Override the default port (default: 5001 in Docker)
163-
164140## Logging
165141
166142The application uses a comprehensive logging system:
@@ -222,6 +198,9 @@ If you encounter any issues or have questions, please file an issue on the GitHu
222198
223199## Version History
224200
201+ - 0.5.1: Remove docker functionality
202+ - 0.5.0: Cleanup codebase, remove old functionality
203+ - 0.4.4: Fix erratic notification issues
225204- 0.4.2: Enhance monitoring + logging
226205- 0.4.1: Validate Docker container image builds correctly, make CLI co-exist
227206- 0.4.0: Add web interface to daemon + terminal mode
0 commit comments