https://github.com/devvsima/dating-bot
Telegram dating bot Michalangelo(Michi), an analog of Daivinchik(Leo). The bot is intended for making new acquaintances, including friendly ones.
https://github.com/devvsima/dating-bot
aiogram aiogram3 dating dating-app dating-bot i18n leo leonardo matching peewee postgres postgresql redis sqlalchemy telegram telegram-bot telegram-dating-bot tgbot
Last synced: 16 days ago
JSON representation
Telegram dating bot Michalangelo(Michi), an analog of Daivinchik(Leo). The bot is intended for making new acquaintances, including friendly ones.
- Host: GitHub
- URL: https://github.com/devvsima/dating-bot
- Owner: devvsima
- License: other
- Created: 2023-07-24T10:05:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-16T09:28:26.000Z (about 1 month ago)
- Last Synced: 2025-04-16T12:30:45.885Z (about 1 month ago)
- Topics: aiogram, aiogram3, dating, dating-app, dating-bot, i18n, leo, leonardo, matching, peewee, postgres, postgresql, redis, sqlalchemy, telegram, telegram-bot, telegram-dating-bot, tgbot
- Language: Python
- Homepage: https://t.me/michalangelo_bot?start=7ezJ6d
- Size: 1020 KB
- Stars: 18
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram dating bot [Michelangelo](https://t.me/michalangelo_bot?start=Oj0wd) 💞
As support, you can put ⭐️ on the repository =)
- `Aiogram 3`
- `i18n`
- `SqlAlchemy`
- `Matplotlib`, `Geopy`
- `Redis`, `PostgreSQL \ Sqlite`
---
## Navigation
- [Telegram dating bot Michelangelo 💞](#telegram-dating-bot-michelangelo-)
- [Navigation](#navigation)
- [Features](#features)
- [Install](#install)
- [Windows](#windows)
- [Linux](#linux)
- [UV](#uv)
- [Settings](#settings)
- [Bot](#bot)
- [Database](#database)
- [Migrations](#migrations)
- [Redis](#redis)
- [Localization](#localization)
- [Startup](#startup)
- [Python](#python)
- [UV run](#uv-run)
- [Contributing](#contributing)
- [License](#license)
---
## Features
- 💬 **Matchmaking**: Helps users find each other based on shared interests.
- 🌍 **Geolocation**: Uses `Geopy` to determine user locations.
- 📊 **Analytics**: Generates visual graphs with `Matplotlib`.
- 🗂️ **Multilingual Support**: Supports multiple languages via `i18n`.
- ⚡ **High Performance**: Utilizes `Redis` for FSM storage and `PostgreSQL` for database operations.
- 🔒 **Secure**: Implements secure data handling and user privacy.
---
## Install
First you need to bend the repository to the correct derictory.
```bash
git clone https://github.com/devvsima/dating-bot.git
cd dating-bot
```
### Windows
```bash
python3 -m venv .venv
source .venv/bin/activate
pip3 install -r requirements.txt
```
### Linux
```bash
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
> 💡 You may have to install apt install python3.10-venv or something like that.
```
### UV
```bash
uv sync
```
---
## Settings
First, copy the `.env.dist` file and rename it to `.env`:
Now you need to customize the `.env` file
### Bot
| Name | Description | Example |
| --------------------- | ----------------------------------------------------------------------------- | ------------------------ |
| TOKEN | Bot Token from [@BotFather](https://t.me/BotFather) | 1234567:ASDSFDkjdjdsedmD |
| ADMINS | List of administrator id's | 2345678,12345677 |
| MODERATOR_GROUP_ID | (Optional) ID of the administrator group, where user complaints will be sent. | -100123456789 |
| SKIP_UPDATES | Option whether the bot will skip updates while not active | True, False |
### Database
If the settings for the database are not filled out, asynchronous Sqlite will be used.
You can specify a link to the database connection in the DB_URL field.
| Name | Description | Example |
| --------------------- | ---------------------------------------------- | ------------------------------------------------------ |
| DB_NAME | Database name | 1234567:ASDSFDkjdjdsedmD |
| DB_HOST | Database host | 2345678,12345677 |
| DB_PORT | Database port | -100123456789 |
| DB_USER | Database owner | True, False |
| DB_PASS | Database password | postgresql |
| DB_URL | (Optional)Full link to connect to the database | postgresql+asyncpg://user:password@localhost:port/name |
#### Migrations
This project uses **Alembic** for database migrations.
- **Create a new migration:**
```sh
alembic revision --autogenerate -m "Migration description"
```
- **Apply migrations:**
```sh
alembic upgrade head # Apply all new migrations
alembic upgrade "migration_name" # Apply a specific migration
```
- **Rollback migrations:**
```sh
alembic downgrade base # Reset database to the initial state
alembic downgrade "migration_name" # Rollback to a specific migration
```
Ensure `alembic.ini` has the correct database URL before running migrations.
### Redis
The radishes will be used as FSM storage. If redis is not connected the standard aiogram storage will be used.
You can specify a link to the Redis connection in the `RD_URL` field at once.
| Name | Description | Example |
| --------------------- | ---------------------------------------------- | ------------------------ |
| REDIS_HOST | Database host | localhost |
| REDIS_PORT | Database port | 6379 |
| REDIS_DB | Database name | 5 |
| RD_URL | (Optional)Full link to connect to the database | redis://localhost:6379/5 |
### Localization
The bot has localization for 6 languages: en, ru, uk, fr, pl, es
- Collecting all the texts from the project
```bash
pybabel extract --input-dirs=. -o data/locales/bot.pot --project=bot
```
- Create files with translations into different languages
```bash
pybabel init -i data/locales/bot.pot -d data/locales -D bot -l en
pybabel init -i data/locales/bot.pot -d data/locales -D bot -l ru
pybabel init -i data/locales/bot.pot -d data/locales -D bot -l uk
pybabel init -i data/locales/bot.pot -d data/locales -D bot -l fr
pybabel init -i data/locales/bot.pot -d data/locales -D bot -l pl
pybabel init -i data/locales/bot.pot -d data/locales -D bot -l es
```
- Once all the texts are translated, you need to compile all the translations
```bash
pybabel compile -d data/locales -D bot --statistics
```
```bash
pybabel update -i data/locales/bot.pot -d data/locales -D bot
```
---
## Startup
First you need to [install dependencies](#Install) and do a [database migration](#Migrations) if you haven't already done one.
### Python
```bash
python main.py
```
### UV run
```bash
uv run main.py
```
---
## Contributing
We welcome contributions from the community! To contribute:
1. Fork the repository.
2. Create a new branch: `git checkout -b feature/your-feature-name`.
3. Make your changes and commit them: `git commit -m "Add your feature"`.
4. Push your changes: `git push origin feature/your-feature-name`.
5. Create a Pull Request.
Please ensure your code adheres to the project's style and passes all tests.
---
## License
This project is licensed under the **Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)** license. See the [LICENSE](./LICENSE) file for details.