README.md

BroBot

It's not a bot, it's a BroBot. The funniest and most saracastic telegram ChatBot out there!
Click here to add it to Telegram.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

BroBot:
It's not a bot, it's BroBot! BroBot is a telegram chatbot developed in Python which serves a single platform for various functions. This bot isn't just like your regular bots, it can be sarcastic and funny too. It can bring you updates on COVID-19 with just a single command. Not only does it send you memes, it can also run shell commands from the chat. Feeling lazy? BroBot can also help you solve your math homework! You can use this customised bot to get updates from future CSI events too.

Head over to Telegram and experience it for yourself!

Built With

• python
• python-telegram-bot

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Python 3.x

Installation

1. Clone the repo

git clone https://github.com/csivitu/BroBot.git
cd BroBot

2. Install pip packages

pip3 install -r requirements.txt

3. Create a .env file and start the BoT

python3 index.py

Usage

Get coronavirus updates

Get your ChatID

Get memes and jokes

Send a free SMS

Note: This feature is restricted. You can request access by submitting a PR here.

Run shell commands

Note: This feature is restricted. You can request access by submitting a PR here.

Chat with it when bored or make it do your Math homework

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

Distributed under the MIT License. See LICENSE for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

alias-rahil 💻

siddhanttk 🎨

tangobeer 📖

ashikka 📖

parthkgh24 📖

This project follows the all-contributors specification. Contributions of any kind welcome!