Otter ... Welcome Buddy

Bot to help the management of Proyecto Nutria's discord
Report Bug

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Acknowledgments

About The Project

Otter Welcome Buddy has the intention of leverage human interaction with the persons in the discord to help them navigate trough all of our resources.

(back to top)

Getting Started

Prerequisites

You need to install all the prerequisites before following with the instalation except Tox.

1. Precommit
2. Poetry
3. Tox
4. Docker

Installation

1. Install our precommits configuration

   pre-commit install

2. Install all the dependencies for python

   poetry install

3. Install tox inside poetry's env

   poetry shell # activate poetry env
   pip install tox

(back to top)

Configuration

You need the following environmental variables either in a .env file under the root directory of this repository or directly added at your system (or your Docker instance):

• DISCORD_TOKEN: the Discord Bot Token retrieved from the developer page.
• MONGO_URI: address of the MongoDB instance to be used, could be local or Cluster from Atlas.

Dockerize

If you want to use Docker with Docker-Compose, you need to take care of few extra steps.

Dependencies

Be sure to have this two technologies installed:

• Docker Engine
• Docker Compose

Environment Variables

Add these variables in the "environment" (.env) file (additional to the ones required on the Configuration section).

• MONGO_ROOT_USERNAME: username to be created as root user with given credentials to manage MongoDB.
• MONGO_ROOT_PASSWORD: strong password to be used as credentials for MONGO_ROOT_USERNAME.
• MONGO_USERNAME: user that manage the connections of the application into the database.
• MONGO_PASSWORD: credentials configured to the user of the application.

⚠️ You can omit MONGO_URI because will be configured during the creation.

Run

# Build and run the bot
docker-compose up -d

Usage

1. Activate your virtual environment

      poetry shell

2. Run the bot using:

    poetry run python otter_welcome_buddy

3. If you would like to run the build locally:

    tox

Roadmap

• Link the repository to our project dashboard
• Add deepsource
• Add vale
• Enable logging

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Open a Pull Request

(back to top)

Acknowledgments

This README was possible thanks to Best-README

(back to top)