Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evalle/bm-cat
Black Metal Cat Bot for Telegram
https://github.com/evalle/bm-cat
blackmetal bm-cat bot music telegram youtube youtube-api youtube-channel youtube-player youtube-playlist youtube-search
Last synced: about 1 month ago
JSON representation
Black Metal Cat Bot for Telegram
- Host: GitHub
- URL: https://github.com/evalle/bm-cat
- Owner: Evalle
- License: mit
- Created: 2018-10-24T17:34:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T20:26:00.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T09:41:46.918Z (3 months ago)
- Topics: blackmetal, bm-cat, bot, music, telegram, youtube, youtube-api, youtube-channel, youtube-player, youtube-playlist, youtube-search
- Language: Python
- Size: 11.5 MB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Black Metal Cat Bot
Black Metal Cat Bot for Telegram
## Build Status
[](https://travis-ci.com/Evalle/bm-cat)
## Whoami
- Telegram Bot
- Written in Python 3
- you can ask me for some new black metal album via "BM!" message
- I will search the YouTube channels ([Black Metal Promotion](https://www.youtube.com/channel/UCzCWehBejA23yEz3zp7jlcg) and [Atmospheric Black Metal](https://www.youtube.com/channel/UCDLkzWN1rHY4eYkGnVruHVw))
- ... and I will paste the link to the new black metal album into Telegram Channel
- ... together with a funny random Black Metal quote, like *"The problem with most Norwigian bands is that their singers sound like Popay"* - **Cronos from Venom shared his thoughts in 1999**, see more [here](https://steemit.com/music/@worldofmusic/black-metal-most-creepy-quotes)
## How Does it Work
## How to Use
Just add BM-Cat bot into your chat and start a private conversation with him
via @.
## Quickstart Guide
If you want to deploy your own Black Metal bot, use the instruction below.
### Prerequisites
- `python` version 3.7+
- `pip3` version 18.1+
- `docker` version 18.06.1-ce+
### Environment Variables
Name | Description
----------------------------|--------------------------------------------------------------------------------------
BM_CAT_SSL_CERTIFICATE_PATH | The path to a SSL certificate inside of a container (for example: `/etc/ssl/certs/public.pem`)
BM_CAT_PRIVATE_KEY_PATH | The path to a private key (for example: `/etc/ssl/private/privkey.pem`)
PORT | The port on which container should run (container port), (for example: `5000`)
BM_CAT_HOST | The name of the host on which BM-cat bot is running (for example: `example.com`)
BM_CAT_PORT | The host port (for example: `8443`)
BM_CAT_API_KEY | Telegram API KEY (see more [here](https://core.telegram.org/api/obtaining_api_id))
BM_YOUTUBE_API_KEY | YouTube API KEY (see more [here](https://developers.google.com/youtube/v3/getting-started))
### Installation
1. Clone this repository and change the current directory to `bm-cat`
```bash
git clone https://github.com/Evalle/bm-cat.git
```
1. Install all python dependencies via:
```bash
pip install -r requirements.txt
```
1. Generate self-signed certificate pair, (see more [here](https://core.telegram.org/bots/self-signed))
```bash
openssl req -newkey rsa:2048 -sha256 -nodes -keyout private.key -x509 -days 365 \
-out public.pem \
-subj "/C=US/ST=New York/L=Brooklyn/O=Example Brooklyn Company/CN=YOURDOMAIN.EXAMPLE"
```
1. Build docker image
```bash
docker build --build-arg BM_CAT_SSL_CERTIFICATE_PATH=/etc/ssl/certs/public.pem \
--build-arg BM_CAT_PRIVATE_KEY_PATH=/etc/ssl/private/privkey.pem \
--build-arg PORT=5000 --build-arg BM_CAT_HOST=example.com \
--build-arg BM_CAT_PORT=8443 \
--build-arg BM_CAT_API_KEY= \
--build-arg BM_YOUTUBE_API_KEY= \
-t bm-cat:0.0.1 .
```
1. Finally, run docker container
```bash
docker run -d --restart=always --privileged -p 8443:5000/tcp bm-cat:0.0.1
```