arichr/desuko-discord

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<p align="center">
    <h1 align="center">Desuko</h1>
    <p align="center">
        <img src="https://cdn.jsdelivr.net/npm/twemoji@11.3.0/2/svg/26a0.svg" width="20" alt="" valign="top" /> <b>This repository is archived.</b> Please check out <a href="https://docs.pycord.dev/en/stable/ext/tasks/index.html">discord.ext.tasks</a> as a replacement. <img src="https://cdn.jsdelivr.net/npm/twemoji@11.3.0/2/svg/26a0.svg" width="20" alt="" valign="top" />
    </p>
    <p align="center">
        <a href="https://pypi.org/project/desuko/" target="_blank"><img src="https://raster.shields.io/pypi/v/desuko.svg?style=flat&logo=python&logoColor=white" alt="PyPi release" /></a>
        <a href="https://codeclimate.com/github/arichr/desuko-discord/maintainability"><img src="https://api.codeclimate.com/v1/badges/76f40b543de7e3645163/maintainability" alt="CodeClimate maintainability" /></a>
        <br />
        Desuko is an extensible Discord bot, written in Python & Pycord.
    </p>
    <p align="center">
        <a href="https://arichr.github.io/gophient/" target="_blank"><img src="https://raster.shields.io/badge/read-documentation-47b649.svg?style=for-the-badge&logo=python&logoColor=white" alt="Read documentation" /></a>
    </p>
</p>

**Features:**

* **Hackable**: Desuko aims to keep the code clean and intuitive.
* **Extensible**: Desuko can be extended by various modules.
* **Fully configurable**: Everything can be configured via YAML.
* **Async-friendly**: Desuko support asyncronious functions out of the box.

## Getting started
**First steps:**

1. [Installation](https://arichr.github.io/desuko-discord/docs/getting_started/1_Installation/) - Install & run a basic version of Desuko.
2. [Configuration](https://arichr.github.io/desuko-discord/docs/getting_started/2_Configuration/) - Configurate your Desuko using `desuko.yaml`.

**Modules:**

1. [Hello, Desuko!](https://arichr.github.io/desuko-discord/docs/modules/Development/HelloDesuko/) - "Hello, World!" module for Desuko
2. [Handlers and subscribers](https://arichr.github.io/desuko-discord/docs/modules/Development/HandlersAndSubs/) - Handlers and subscribers usage for building event-driven bots