Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svex99/quick-zip-bot
Minimalist Telegram bot to zip files.
https://github.com/svex99/quick-zip-bot
asyncio telegram telethon zip
Last synced: 3 months ago
JSON representation
Minimalist Telegram bot to zip files.
- Host: GitHub
- URL: https://github.com/svex99/quick-zip-bot
- Owner: svex99
- License: mit
- Created: 2022-01-22T17:35:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-07T17:35:07.000Z (about 1 year ago)
- Last Synced: 2024-05-29T03:28:07.948Z (6 months ago)
- Topics: asyncio, telegram, telethon, zip
- Language: Python
- Homepage:
- Size: 11.7 KB
- Stars: 21
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# quick-zip-bot
Minimalist Telegram bot to zip files.
## Features
- Full async, not blocking I/O.
- Concurrent download and zipping of files.
## Usage
1. Send the command `/add`, this notifies the bot that you are going to send some files to zip in a single file.
2. Send the files (photos, videos, documents, etc.) you want to add, total size must not exceed 1.95 GB.
3. Send `/zip ` command where filename (admitted characters: A-Za-z0-9_) is the name of the zip you want to get. Ex: `/zip summer_photos` will create a zip file with name `summer_photos.zip`.
Send `/cancel` instead of `/zip` if you want to finish the process and not create the zip file.
## Deployment
### Environment Variables
You need to define the environment variables required for the bot to work. Where or how to define them depends on the method used to run the bot. You can use locally an .env file like `.env.example`.
| Variable | Required | Description |
| :---------: | :-------: | :----------------------------------------------------------------------: |
| `API_ID` | yes | Your personal Telegram API ID from https://my.telegram.org. |
| `API_HASH` | yes | Your personal Telegram API hash from https://my.telegram.org. |
| `BOT_TOKEN` | yes | The token of your bot created with [@botfather](https://t.me/botfather). |
| `CONC_MAX` | default=3 | Max amount of files to be downloaded concurrently. |
### Locally
Create a virtual environment to install the dependencies isolated of other projects you are working on.
```
$ python -m venv env
$ source env/bin/activate
```
Install the dependencies and run the bot.
```
$ pip install -r requirements.txt
$ python src/bot.py
```
### Docker
Build the image with the provided Dockerfile.
```
$ docker image build -t quick-zip-bot .
```
Run the image with your .env file.
```
$ docker container run -d --name quick-zip-bot --env-file .env quick-zip-bot
```
### Railway
> not free anymore
1. Fork this repository to your GitHub account, and give it a star :).
2. Login or create your [Railway](https://railway.app?referralCode=hL5gIG) account as needed.
3. Create a new project on Railway by choosing `GitHub Repo` option and selecting the repository you forked on step 1.
4. Click the new project created and go to `Variables` section, where you must set the environment variables.
5. You are ready to use the bot when deployment is ready, this may take a bit.
## Contribute
I'll be happy to receive any issue or pull request to improve the bot, fell free to contribute.