Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohammadrezaamani/uniland
A highly modular and diverse Telegram Bot for universities and institutions written in python. This is the effort of a group of eight CS students at AUT as the final project for Software Engineering Course (1380044).
https://github.com/mohammadrezaamani/uniland
orm pyrogram python sqlalchemy telegram telegram-bot
Last synced: about 1 month ago
JSON representation
A highly modular and diverse Telegram Bot for universities and institutions written in python. This is the effort of a group of eight CS students at AUT as the final project for Software Engineering Course (1380044).
- Host: GitHub
- URL: https://github.com/mohammadrezaamani/uniland
- Owner: MohammadrezaAmani
- License: mit
- Created: 2022-11-05T09:54:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-09T12:49:15.000Z (12 months ago)
- Last Synced: 2024-01-10T09:28:12.655Z (12 months ago)
- Topics: orm, pyrogram, python, sqlalchemy, telegram, telegram-bot
- Language: Python
- Homepage: https://t.me/UniLandbot
- Size: 843 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Highly Modular and Diverse Telegram Bot
Bot
•
Documentation
•
Channel
•
Support
# UniLand Telegram Bot
> *An instance of this bot is active at [UniLand Telegram Bot](https://t.me/UniLandbot "UniLand Bot")*
A highly modular and diverse Telegram Bot for universities and institutions written in python. This is the effort of a group of eight CS students at [AUT](https://math.aut.ac.ir/index.php?sid=7&slc_lang=en "Amirkabir University of Technology") as the final project for Software Engineering Course *(1380044)*.
* [Requirements](#Requirements)
* [Python Compatibility](#Python-Compatibility)
* [Dependencies](#Dependencies)
* [Instructions](#Instructions)
* [Key Features](#Key-Features)
* [License](#License)
## Requirements
### **Python Compatibility**
This bot is written entirely in python. tested versions are `python 3.11, 3.10, 3.9, 3.8, 3.7` while older versions should not cause any problem, we recommend using the latest version of `python3`.
### **Dependencies**
This package requires the following packages:
* [pyrogram](https://github.com/pyrogram/pyrogram "Pyrogram Github") - Telegram MTProto API
* [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy "SQLAlchemy Github") - SQL & ORM Toolkit
* [uvloop](https://github.com/MagicStack/uvloop "uvloop Github") - Asynchronus Programming
* [TgCrypto](https://github.com/pyrogram/tgcrypto "TgCrypto Github") - Secure Encryption for Telegram Protocols
## Instructions
To run the bot, you need to have a Telegram API ID and API Hash. You can get them from [my.telegram.org](https://my.telegram.org "Telegram API"). Then, you need to create a `config.py` file in the root directory of the project and fill it with the following information:
```python
API_ID = # Your API ID
API_HASH = # Your API Hash
BOT_TOKEN = # Your Bot Token
REPL_URL = # Your Replit URL
```
> ~~We recommend using a [Repl](https://replit.com/ "Replit") to host the bot but if you have your own server, replace `REPL_URL` with its URL.~~
>
> *[Replit](https://replit.com/) no longer supports Telegram bots, use another vps or hosting service.*
Then, you can run the bot using the following command:
```bash
python3 -m uniland
```
## Key Features
Some of the key feature are listed below. For more information, please refer to the Documentation.
* **Modular** - Highly modular and can be easily extended.
* **Easy to Use** - Easy to customize the interface and messages.
* **Diverse** - Can be used for a wide range of purposes.
* **Secure** - Uses the latest encryption protocols matched by Telegram's MTProto.
* **Fast** - Build with the fastest performing asynchronus libraries to achieve high performance.
## License
Distributed under the MIT License. See `LICENSE` for more information.