The ultimate tool to automate custom telegram message forwarding.
Project description
tgcf
The ultimate tool to automate telegram message forwarding.
The key features are:
- Two modes of operation are past or live for dealing with either existing or upcoming messages.
- Supports login with both telegram bot account as well as user account.
- Custom filter replace watermark ocr and whatever you need !
- Detailed docs 📚 + Video tutorial + Help from community in discussion forum 😎.
- If you are a python developer, writing plugins 🔌 is like stealing candy from a baby.
What are you waiting for? Star 🌟 the repo and click Watch 🕵 to recieve updates.
You can also join the official Telegram Channel, to recieve updates without any ads.
Video Tutorial 📺
A youtube video is coming soon. Subscribe to get notified.
Run Locally 🔥
Note: Make sure you have Python 3.8 or above installed. Go to python.org to download python.
Click on your platform of choice for a more detailed guide.
Platform | Supported |
---|---|
Windows | ✅ |
Mac | ✅ |
Linux | ✅ |
Android | ✅ |
If you are familiar with Docker, you may go that way for an easier life.
Open your terminal and run the following commands.
pip install --upgrade tgcf
To check if the installation succeeded, run
tgcf --version
If you see an error, that means installation failed.
Configuration 🛠️
Configuring tgcf
is easy. You just need two files in your present directory
(from which tgcf is invoked).
-
.env
: To define your environment variables easily. -
tgcf.config.yml
: Anyaml
file to configure howtgcf
behaves.
Start tgcf
✨
In your terminal, just run tgcf live
or tgcf past
to start tgcf
.
It will prompt you to enter your phone no. or bot token, when you run it
for the first time.
For more details run tgcf --help
or read docs.
Run on Cloud 🌩️
Deploying to a cloud server is an easier alternative if you cannot install
on your own machine.
Cloud servers are very reliable and great for running tgcf
in live mode
for a long time.
Platform | Pros | Cons |
---|---|---|
free for 450 hr/mo | can't use tgcf in past mode | |
speed and reliability | starts from $5/mo | |
easily edit config file | only 50 hr/mo free |
Other options
- Python Anywhere
- Google Cloud Run
- Scheduled using GitHub Actions
Getting Help 💁🏻
- First of all read the wiki and watch the videos to get started.
- Search your problem everywhere !
- Feel free to ask your questions in the Discussion forum.
- For reporting bugs or requesting a feature please use the issue tracker for this repo.
Contributing 🙏
PRs most welcome! Read the contributing guidelines to get started.
Also read:
If you are not a developer, you may also contribute financially to incentivise the development of any custom feature you need.
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
Hashes for tgcf-0.1.35.post0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0536c61e40aaa1bbb329c8cf7622474d2b1c28d7c150e3bc3a630e4504d2d710 |
|
MD5 | 38ea95c0a81d5772eed3f1d08ddb3321 |
|
BLAKE2b-256 | b40beb9bcf2b199c3ebbbcae1d2c813fa29f4fc9ae395631d006244304e9219c |