Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethanc/bluebird
Monitor users on X (Twitter) and notify about post activity.
https://github.com/ethanc/bluebird
bot discord docker docker-compose monitor notification notifications notifier notify post python reply repost retweet script tweet twitter watcher webhook x
Last synced: about 1 month ago
JSON representation
Monitor users on X (Twitter) and notify about post activity.
- Host: GitHub
- URL: https://github.com/ethanc/bluebird
- Owner: EthanC
- License: mit
- Created: 2024-03-04T01:31:16.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T04:26:41.000Z (4 months ago)
- Last Synced: 2024-08-26T03:43:15.433Z (4 months ago)
- Topics: bot, discord, docker, docker-compose, monitor, notification, notifications, notifier, notify, post, python, reply, repost, retweet, script, tweet, twitter, watcher, webhook, x
- Language: Python
- Homepage: https://hub.docker.com/repository/docker/ethanchrisp/bluebird
- Size: 70.3 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bluebird
  
Bluebird monitors users on X and reports new posts via Discord.
## Setup
Although not required, a [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) is recommended for notifications.
An X account is required. It is recommended to use a throwaway account due to use of the internal API.
**Environment Variables:**
- `LOG_LEVEL`: [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to write to the console.
- `LOG_DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive log events.
- `LOG_DISCORD_WEBHOOK_LEVEL`: Minimum [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to forward to Discord.
- `USERS_ALL`: Comma-separated list of [X](https://x.com/) usernames to monitor for all posts.
- `USERS_TOP`: Comma-separated list of [X](https://x.com/) usernames to monitor for top-level posts only.
- `USERS_MEDIA`: Comma-separated list of [X](https://x.com/) usernames to monitor for media posts only.
- `COOLDOWN_MIN_TIME`: Minimum randomized cooldown time between checking for new posts (default is 60).
- `COOLDOWN_MAX_TIME`: Maximum randomized cooldown time between checking for new posts (default is 300).
- `X_CSRF_TOKEN`: CSRF Token obtained via request inspection on [X](https://x.com/).
- `X_AUTH_TOKEN`: Cookie Auth Token obtained via request inspection on [X](https://x.com/).
- `X_BEARER_TOKEN`: Authentication Bearer Token obtained via request inspection on [X](https://x.com/).
- `DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive new post notifications.
### Docker (Recommended)
Modify the following `compose.yaml` example file, then run `docker compose up`.
```yml
services:
bluebird:
container_name: bluebird
image: ethanchrisp/bluebird:latest
environment:
LOG_LEVEL: INFO
LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY
LOG_DISCORD_WEBHOOK_LEVEL: WARNING
USERS_ALL: Mxtive,spectatorindex,Breaking911
USERS_TOP: X,XData
USERS_MEDIA: archillect
COOLDOWN_MIN_TIME: 60
COOLDOWN_MAX_TIME: 300
X_CSRF_TOKEN: XXXXXXXX
X_AUTH_TOKEN: XXXXXXXX
X_BEARER_TOKEN: XXXXXXXX
DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX
restart: unless-stopped
```
### Standalone
Bluebird is built for [Python 3.12](https://www.python.org/) or greater.
1. Install required dependencies using [uv](https://github.com/astral-sh/uv): `uv sync`
2. Rename `.env.example` to `.env`, then provide the environment variables.
3. Start Bluebird: `python bluebird.py`