A telegram bot that applies watermark on images, gifs and videos.
Project description
telewater
A telegram bot that applies watermark on images, gifs and videos.
Features
- Fast because it is made using async libraries.
- Simple to use.
- Any one who uses an instance of the bot will have to use the same watermark and position. This is meant to be used by single person/organization (by only you or your team), as configuration is stored at a global level instead of per user basis.
- No database connection required.
- It does not store media (photos/videos/gifs) on the server. Media is deleted immediately after the watermarked version is sent to the user.
Watch this video on YouTube to learn how to use and deploy this bot.
Usage
Using the bot is very simple. Just send a photo, video or gif to the bot. The bot will reply with the watermarked media.
The bot commands /set
and /get
can set and get the value of the configuration variables. The commands are simple and intuitive. The bot will show you the usage if you send an incorrect argument.
Deploy
Click on this link and get free 100$ on Digital Ocean.
NOTE You will get nothing if you directly sign up from Digital Ocean Home Page. Use the link above, or click on the big fat button above to get free 100$.
Read the Guide to Deploy to Digital Ocean.
This application can also be easily deployed to Heroku, which is extremely good if you want to enjoy a free tier.
You may read further to learn about more more deployment options.
Click on the above button. A form will appear, where you need to enter the credentials for the bot. After the app is deployed sucessfully, turn on the woker dyno to start the bot.
Installation
The following is the guide to install telewater
on your computer, or VPS.
If you are a beginner, don't bother yourself with these. Just go ahead with the heroku method described abvoe.
If you are familiar with Docker then click here otherwise, continue reading.
Requirements
Make sure to have these installed in your system.
- python3.9+ and pip (the bot is built with the telethon library)
- ffmpeg (used by the bot for applying watermark)
Verification
Open you terminal to check if you have all basic requirements properly installed.
-
Run
python --version
and you should get something like thisPython 3.9.2
(or above). -
Run
pip --version
and you should getpip 20.2.2
(or above).Some systems may require to use
python3
andpip3
instead of the above. -
Run
ffmpeg -h
and it should display a help message and version above4.2.4
.
Install via pip
pip install telewater
Starting telewater
Telewater has a simple command line interface to start the bot.
Simply open your terminal and run telewater
. It will prompt you to enter the required information.
Further reading
- Environment Variables
- Telewater CLI usage
- Install and run using docker
- Deploy to Digital Ocean
- Run multiple instances
For any further help, feel free to create an issue in the GitHub repo.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file telewater-0.1.5.post2.tar.gz
.
File metadata
- Download URL: telewater-0.1.5.post2.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.8.0-59-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a76ee41b4394fe9df6da9e8ec459d8b20abcc31dc4511f5678a79cd8da62b892 |
|
MD5 | fcadc53db0d94b6f68b826f001dfc72e |
|
BLAKE2b-256 | 0a8505ce5cfb293b7cd476b7a981d9e999d69c3be15e3bb2276d9ca8d3792ef2 |
File details
Details for the file telewater-0.1.5.post2-py3-none-any.whl
.
File metadata
- Download URL: telewater-0.1.5.post2-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.8.0-59-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e81e5491166f389e5c59bd9e99b44963d66872f40266d95b4edf1e356c8c2b0 |
|
MD5 | d112d4a5707155f786879bf8e9b61170 |
|
BLAKE2b-256 | b6829cbf0e356c8467ae709eff1c59d0081ad37ad85616547d55d26ee8f95396 |