Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/athphane/userbot
Telegram Userbot built with Pyrogram
https://github.com/athphane/userbot
pyrogram python telegram telegram-bot
Last synced: 3 months ago
JSON representation
Telegram Userbot built with Pyrogram
- Host: GitHub
- URL: https://github.com/athphane/userbot
- Owner: athphane
- License: gpl-3.0
- Created: 2019-10-18T18:23:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-01T19:06:08.000Z (4 months ago)
- Last Synced: 2024-03-01T20:25:26.103Z (4 months ago)
- Topics: pyrogram, python, telegram, telegram-bot
- Language: Python
- Size: 6.69 MB
- Stars: 141
- Watchers: 11
- Forks: 107
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome - athphane/userbot - Telegram Userbot built with Pyrogram (Python)
- awesome-maldives - User bot - Telegram Userbot built with Pyrogram. (Table of Contents / PYTHON Projects)
README
# Pyrogram Userbot
[](https://github.com/athphane/userbot/pulse)
[](https://app.codacy.com/manual/athphane/userbot?utm_source=github.com&utm_medium=referral&utm_content=athphane/userbot&utm_campaign=Badge_Grade_Settings)
[](http://hits.dwyl.com/athphane/userbot)
[](https://github.com/athphane/userbot/graphs/contributors)
[](LICENSE)
> A Telegram Userbot based on [Pyrogram](https://github.com/pyrogram/pyrogram)
This repository contains the source code of a Telegram Userbot and the instructions for running a
copy yourself. Beside its main purpose, the bot is featuring [**Pyrogram Asyncio**](https:////github.com/pyrogram/pyrogram/issues/181) and
[**Smart Plugins**](https://docs.pyrogram.org/topics/smart-plugins); feel free to explore the source code to
learn more about these topics.
I assume you will read this whole README.md file before continuing.
## Requirements
You're gonna need to get the following programs and services either installed on your server
or signed up for. You must do all. It is a cardinal sin if you don't.
* Python 3.10 (requirements were generated for 3.10. Python 3.8 is supported from the looks of it.)
* `virtualenv` installed so that the packages don't interfere with other system packages.
* [MongoDB](https://www.mongodb.com) on your server or a free server from
[MongoDB Atlas](https://www.mongodb.com/cloud/atlas). (I recommend Atlas as I used it during
development with no issues.)
* [carbon-now-cli](https://github.com/mixn/carbon-now-cli) on your server too generate code images for the
[carbon.py](/userbot/plugins/carbon.py) module. I use this CLI tool cause I don't know and couldn't get selenium
and chromedriver to work nicely on my server/code. I'll be nice and even give you the command to install this.
I assume you already have NPM installed.
```
Windows: npm install -g carbon-now-cli
Linux: sudo npm install -g carbon-now-cli --unsafe-perm=true --allow-root
MacOS: I assume almost the same as linux ¯\_(ツ)_/¯
```
## Installation and Deployment
*The way I deploy*
```bash
git clone https://github.com/athphane/userbot.git
cd userbot
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
python -m userbot
```
*Using docker*
- Save the following content as `docker-compose.yml`
```yml
version: '3.5'
services:
userbot:
hostname: userbot
volumes:
- ./config:/root/userbot/config
image: ghcr.io/athphane/userbot:latest
```
- First run:
```bash
docker compose run --rm userbot python -m userbot
```
- Configure userbot and stop container **CTRL+C**
- Run the container again de-attached:
```bash
docker compose up -d
```
## Spotify integration
To get the Spotify commands working on the Userbot, you need to get a CLIENT_ID and CLIENT_SECRET
form the [Spotify Developer Portal]('https://developer.spotify.com/dashboard/applications) and add
them into your userbot.ini file.
On the Spotify developer portal, make sure to set your application `Redirect URI` to
'http://localhost:8888/callback'.
Now is a good time
Then go ahead and run the command `python spotify.py`
in the projects root directory.
This will create a file called `.cache-yourusername`. You need to transfer this file to the
project root of the server that will be running your userbot. This is a one time setup.
## Known issues
* `.restart` command do not work on Termux as [psutils is not supported on Android](https://github.com/giampaolo/psutil/issues/913). \
CTRL+C, run `git pull` and `python -m userbot` to update bot on termux.
## Star History
## Credits, and Thanks to
* [Dan](https://t.me/haskell) for his [Pyrogram Library](https://github.com/pyrogram/pyrogram)
* [Colin Shark](https://t.me/ColinShark) for his [PyroBot](https://git.colinshark.de/PyroBot/PyroBot) which helped with
most of the useful functions used.
* The people at [MyPaperPlane](https://github.com/MyPaperPlane) for their [Telegram-UserBot](https://github.com/MyPaperPlane/Telegram-UserBot)
that gave a ton of ideas on how and what modules to include in this userbot.
* [Baivaru](https://github.com/baivaru) for the ton of help that got me this far into making this repo.
---
Made with love from the Maldives ❤