Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gspvk/anirecombot

Anime recommendations bot for Telegram
https://github.com/gspvk/anirecombot

aiogram anime bot python recommendations selenium sqlite sqlite3 telegram

Last synced: about 1 month ago
JSON representation

Anime recommendations bot for Telegram

Awesome Lists containing this project

README

        

# AniRecomBot

The bot generates a list of recommendations based on the MyAnimeList account.
Recommendations are obtained through scraping from this site: https://anime.ameo.dev/
The bot can also show a random quote, picture or gif using various APIs.

**You can check out the bot here:** https://t.me/anirecombot

## 🤖 Usage

The bot executes all commands using the corresponding buttons in the menu.

- `Quote` - Random quote.
- `PicRandom` - Random picture.
- `SFW`
- `Get picture`
- `NSFW`
- `Get picture`
- `I WANT EVERYTHING!`
- `Get SFW pic`
- `Get NSFW pic`
- `B..baka!` - Random "baka" gif.
- `Anime Recommendations` - Recommendations. When clicked, it will ask for a "MyAnimeList" nickname. Has its own
submenu:
- `Next` - Show next recommendation.
- `Update recs` - Update list of recommendations.

## ⚙️Getting started:
This project can be installed via 🐍Pip or 🐳Docker. To get started, clone the repository to your local machine
and navigate to the project directory.
```shell
$ git clone https://github.com/GSPVK/AniRecomBot/
$ cd AniRecomBot
```

### 🐍 Pip
0. You must have redis and firefox installed.
1. Create a virtualenv (This step is optional, but highly recommended to avoid dependency conflicts)
2. Activate the venv and install requirements.
3. Create a `.env` file in the root of project directory (you can use the provided `example.env` file as a template.)
4. Run `python3 -m anirecombot.bot`

```shell
$ python3 -m venv .venv # on win: "py -m venv .venv"
$ . .venv/bin/activate # on win: ".venv/Scripts/activate"
(.venv) $ pip install -r requirements.txt
# Create a .env file, as described in step 4
(.venv) $ python3 -m anirecombot.bot # on win: "py -m anirecombot.bot"
```

### 🐳 Docker
1. Create a `.env` file in the root of project directory (there is a `.envExample` to use as a template.)
2. Run `docker compose up`

Also, if you want to create a loading animation, then send the bot a GIF and insert the received `file_id` into
the animation parameter in `handlers/ani_recomms.py:48`, then uncomment the lines.