https://github.com/abbybot/abbybot-api

AbbyBot web API for webpage and data.
https://github.com/abbybot/abbybot-api

api api-gateway bot-api discord-api discord-bot discord-bot-api dotenv flask mysql requests

Last synced: 4 months ago
JSON representation

AbbyBot web API for webpage and data.

• Host: GitHub
• URL: https://github.com/abbybot/abbybot-api
• Owner: AbbyBot
• Created: 2024-08-24T21:31:29.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-12-08T01:54:46.000Z (7 months ago)
• Last Synced: 2024-12-24T05:46:12.223Z (6 months ago)
• Topics: api, api-gateway, bot-api, discord-api, discord-bot, discord-bot-api, dotenv, flask, mysql, requests
• Language: Python
• Homepage:
• Size: 403 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![AbbyBot-Api](https://github.com/user-attachments/assets/d17a12fc-bb64-4b7c-88dc-529505f1a5c6)

This API is an integral component of the AbbyBot project, providing comprehensive data services related to Discord bot servers, users, and bot-specific information.



  

  

  

  

  



## Requirements

- ![Python](https://img.shields.io/badge/Python-3.10.0+-4caf50?style=flat-square&logo=python&logoColor=white) Python 3.10.0 or later

- ![Flask](https://img.shields.io/badge/Flask-2.1-2196f3?style=flat-square&logo=flask&logoColor=white) Flask

- ![MySQL](https://img.shields.io/badge/MySQL-8.0-ffeb3b?style=flat-square&logo=mysql&logoColor=white) MySQL connector

- ![dotenv](https://img.shields.io/badge/dotenv-5.0-4caf50?style=flat-square&logo=dotenv&logoColor=white) dotenv

- ![requests](https://img.shields.io/badge/requests-2.26.0-2196f3?style=flat-square&logo=python&logoColor=white) requests

Make sure you have all the necessary packages installed by running:

```

pip install -r requirements.txt

```

## Environment Variables

To configure the API, you need a `.env` file with the following variables:

```

DB_HOST=example.com

DB_USER=example_user

DB_PASSWORD=example_password

BOT_VERSION=1.0.0

DB_DISCORD_NAME=example_discord_db

DB_API_NAME=example_api_db

DB_WISHLIST_NAME=example_wishlist_db

```

>Note: The system is designed for the database user (DB_USER) to use only one host (DB_HOST) and must have the necessary read and write permissions for all databases (DB_DISCORD_NAME, DB_API_NAME, DB_WISHLIST_NAME). Therefore, everything should be unified.

## Running the API

1. Clone the repository and navigate to the folder.

2. Set up your `.env` file with the appropriate values.

3. Run the Flask application:

```

python main.py

```

> The API will be available at `http://127.0.0.1:5002/`.



  ## Endpoints list