AuroraBot is a Python-based project that allows you to interact with the Aurora API through a Telegram bot. The bot is designed to provide users with an intuitive and user-friendly interface to interact with Aurora API services without the need for complex API calls or direct interaction with the API.
- User-friendly interaction with the Aurora API
- Automatic authorization and token management
- Telegram bot for easy access and usage
- Customizable settings and credentials
These instructions will help you set up the project on your local machine and get the bot running.
Ensure that you have the following software installed on your system:
- Python 3.7 or higher
- pip (Python package manager)
- Clone the repository to your local machine:
git clone https://github.com/4erdenko/AuroraBot.git
- Change the directory to the project folder:
cd AuroraBot
- Install the required packages:
pip install -r requirements.txt
- Update the
credentials.json
file with your own credentials:
LOGIN
: Your Aurora API loginPASSWORD
: Your Aurora API passwordTELEGRAM_BOT_TOKEN
: Your Telegram bot token
Alternatively, you can enter the credentials when prompted by running main.py
.
- (Optional) Create a
.env
file with the required environment variables. In the root of the project, create a.env
file with the following lines:
LOGIN=
PASSWORD=
TELEGRAM_BOT_TOKEN=
Fill in the values for each environment variable.
- Run the bot:
python main.py
Now, the bot should be up and running. You can interact with it using the Telegram application.
To use the bot, follow these steps:
- Open the Telegram application and search for your bot using its username.
- Start a chat with the bot.
- Use the available commands to interact with the Aurora API through the bot.
If you'd like to contribute to the project, please follow these steps:
- Fork the repository.
- Create a new branch with your feature or bugfix.
- Commit your changes to the branch.
- Push the changes to your fork.
- Create a pull request with a description of the changes.
We appreciate all contributions and will review each pull request carefully.
This project is licensed under the MIT License. See the LICENSE file for details.