Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxme1/subscriber
A Telegram bot that keeps all your subscriptions in one place
https://github.com/maxme1/subscriber
telegram-bot
Last synced: about 1 month ago
JSON representation
A Telegram bot that keeps all your subscriptions in one place
- Host: GitHub
- URL: https://github.com/maxme1/subscriber
- Owner: maxme1
- Created: 2018-12-23T21:26:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T17:29:09.000Z (6 months ago)
- Last Synced: 2024-10-29T23:15:34.110Z (3 months ago)
- Topics: telegram-bot
- Language: Python
- Homepage:
- Size: 130 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A Telegram bot that keeps all your subscriptions in one place
It can notify you about:
- new videos in [YouTube](https://www.youtube.com/) channels
- new posts in [Twitter](https://twitter.com/) feeds
- new concerts for artists and bands from [SongKick](https://songkick.com/)
- new posts from [VK](https://vk.com/) public channels
- new [Kaggle](https://www.kaggle.com/) competitions
- new [GrandChallenge](https://grand-challenge.org/) competitions
- new entries in any RSS feed
Just send it a link to a channel or a feed, and it will notify you about new entries!
# Supported commands
```
start - show a greeting message
list - show your subscriptions
delete - choose subscriptions to delete
```
# Running the bot
First, create an `.env` file in the `services` folder and define there the env variables:
- `TELEGRAM_TOKEN` - the Telegram bot token. Use [@botfather](https://t.me/botfather) to get one
- `KAGGLE_USERNAME`, `KAGGLE_KEY` - [your kaggle API credentials](https://github.com/Kaggle/kaggle-api#api-credentials)
## Locally
1. Add these env variables to the same file:
- `STORAGE_PATH` - the path where various files (such as images) will be stored
- `DB_PATH` - the path where the database will be stored
2. Then run
```shell
pip install -r requirements.txt
python services/main/main.py
```
## With Docker Compose
1. Add these env variables to the same file:
- `VOLUMES_ROOT` - the base path where various docker volumes will be stored
2. Create the `db`, `logs` and `storage` folders inside `VOLUMES_ROOT`
3. Run
```
docker compose up --build
```