🔱 SAGDIB

Python discord bot for Samegaki needs

Table of Contents

• Introduction
• Installation
• Usage
• Documentation
• License

Introduction

SAGDIB is open source discord bot written in Python. It's primary purpose is to satisfy Samegaki group needs.

Whole project is managed by Poetry which is used for dependency control and virtual environment management.

Installation

To install SAGDIB, you need to have Python version 3.9 or higher and Poetry installed on your system. For more information on how to install Poetry, please refer to Poetry documentation.

1. Clone the repository

git clone https://github.com/samegaki-eu/SAGDIB

2. Change directory to the cloned repository

cd SAGDIB

3. Install dependencies

poetry install

4. Copy the .env.sample file to .env and fill in the required values

For more information about the environment variables, please refer to the Configuration section in the documentation.

cp .env.sample .env

Usage

To start the bot, you can use the following command:

poetry run task run

To spawn a shell inside the virtual environment, you can use the following command:

poetry shell

Documentation

Documentation is automatically generated by Sphinx and it is available here.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

⬆ Back to Top