Repository files navigation

NeorgBot - A Bot For The Neorg Discord Server

Summary•Setup•Usage

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.

Python 3.10 is recommended.

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

1. Installpoetry by following theinstructions.
2. Create an environment withpoetry env use python.
3. Runpoetry update to install the dependencies listed in thepyproject.toml file.

After installation of the dependencies, run the bot withpoetry 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 withpoetry run task test. For additional information we recommend reading thereadme.md file found in thetests folder.