search

vsedov / NeorgBot

Neorg Discord Bot
GNU General Public License v3.0
14 stars 3 forks source link
bot discord discord-api discord-bot hacktoberfest hacktoberfest-accepted neorg

readme

# NeorgBot - A Bot For The Neorg Discord Server ![Discord](https://img.shields.io/badge/discord-join-7289da?style=for-the-badge&logo=discord) ![GitHub](https://img.shields.io/badge/Neorg%20-visit-blue.svg?style=for-the-badge&logo=GitHub) ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge) [Summary](#summary) • [Setup](#setup) • [Usage](#usage)

## Summary

This is a bot for the Neorg discord server, to be used for searching through the Neorg wiki and spec; many other quality of life features e.g. searching through YouTube videos, pulling up Neovim documentation etc.

Setup

Python 3.10 is recommended.

Start by cloning the repository with git clone git@github.com:vsedov/NeorgBot.git.

Dependencies

  1. Install poetry by following the instructions.
  2. Create an environment with poetry env use python.
  3. Run poetry update to install the dependencies listed in the pyproject.toml file.

Usage

After installation of the dependencies, run the bot with poetry run task start (make sure to be in the root directory of the repository before running the command).

IMPORTANT: Before making a pull request, test whether your code works as intended and has passed all checks from the linters with poetry run task test. For additional information we recommend reading the readme.md file found in the tests folder.