Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zaitsev-dev/benzin-io-bot
Telegram bot for removing the background from an image
https://github.com/zaitsev-dev/benzin-io-bot
aiogram aiohttp photo-editing python telegram-bot
Last synced: about 2 months ago
JSON representation
Telegram bot for removing the background from an image
- Host: GitHub
- URL: https://github.com/zaitsev-dev/benzin-io-bot
- Owner: zaitsev-dev
- License: apache-2.0
- Created: 2022-12-20T14:00:32.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-20T20:05:42.000Z (about 2 years ago)
- Last Synced: 2024-07-20T07:10:37.809Z (6 months ago)
- Topics: aiogram, aiohttp, photo-editing, python, telegram-bot
- Language: Python
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Benzin IO bot
Benzin-io is a small, asynchronous application that removes the background of the image.
It uses a [third-party API](https://benzin.io/) to process the photos and
the [Telegram Bot API](https://core.telegram.org/bots/api) to implement the user
interface.
It also uses _aiogram_ to implement fast and async Telegram bots, _aiohttp_ to send async
requests, and _loguru_ for logging.
## Installation
Firstly, you should create your Telegram bot and get its
token ([read more](https://core.telegram.org/bots#how-do-i-create-a-bot)). Also, you have
to create a Benzin.io account and take their API key
too ([read more](https://benzin.io/integration/api-docs/)). Finally, if you're done, you
can start an installation.
Clone the repository and go into it:
```shell
git clone https://github.com/Leetovskiy/benzin-io-bot.git
cd benzin-io-bot
```
In this step, you have two options: use `pipenv` or `pip`. If you choose `pip` you should
manually create a virtual environment to avoid conflicts with the system environment.
`pipenv` does it by itself, so you do not need to do anything.
```shell
# For pip users
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
# For pipenv users
pipenv install
```
Next, you should pass your Telegram bot token and Benzin.io API key to environment
variables. You may also want to create an.env file and store this information in it if you
use `pipenv`.
```shell
# For pip users
export BOT_TOKEN=""
export BENZIN_TOKEN=""
```
```dotenv
# .env file (for pipenv users)
BOT_TOKEN=
BENZIN_TOKEN=
```
All right, that's it. Try running `main.py` and sending the `/start` command to chat.
```shell
python main.py
```
## License
The Apache 2.0 license applies to the project's sources. For further details, refer to
the [LICENSE.txt](https://github.com/Leetovskiy/benzin-io-bot/blob/master/LICENSE.txt)
file.
## Contribution
Feel free to make a pull request and contribute if you accept the Apache 2.0 license. I'm
also open to discussing any suggestions you may have regarding this project.
---