/NeorgBot

Neorg Discord Bot

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

NeorgBot Coverage

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.


Getting Started - Contributors

Python 3.10 is recommended.

1. Downloading the repository:

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

2. Configuring the 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.
  4. After installation of the dependencies, run the bot with poetry run task start.
  5. Before making a pull request, test whether your code works as intended with poetry run task test. For additional information read the readme.md found in tests folder.

Discord GitHub