MasterJ93 / cephalon_seren

A Discord bot for the Shinobi of the Lotus server.

Cephalon Seren

Cephalon Seren is a Warframe-focused Discord bot. Even though his main goal is to moderate the Shinobi of the Lotus Discord server, he also helps with onboarding new members, delivers invite request, and posting billboards for other clans.

If you'd like to join the Shinobi of the Lotus clan or its respective alliance, you can visit us at https://discord.gg/fpg88dzeyP. We do require you to be actively playing Warframe, however. If you want to join the clan, you need to at least be 18 years old as well.

Installation

Production

To put this into a server or host it onto your local computer, we require a few prerequisites:

• Python 3.10 or higher.
• discord.py
• aiofiles
• (Optional, but recommended) pyenv-virtualenv (for managing the project-specific virtual environments)

Development

For development, we also require the following:

• pytest
• pytest-asyncio

Setting up the Environment

1. Install pyenv and pyenv-virtualenv

   If you haven't already installed pyenv and pyenv-virtualenv, please follow the instructions on the pyenv and pyenv-virtualenv GitHub pages respectively.

2. Clone the Repository:

   git clone https://github.com/MasterJ93/cephalon_seren.git
   cd cephalon-seren

3. Setup the Python Environment:

   When you enter the project directory, pyenv should automatically detect and set the Python version and virtual environment as specified in the .python-version file.

   If it's your first time, you'll need to create the virtual environment:

   pyenv virtualenv 3.10 cephelon-seren-venv

4. Activate the Virtual Environment: This step is usually automatic thanks to the .python-version file in the project directory. If you need to activate the environment manually, use:

   pyenv activate cephelon-seren-venv

5. Install Dependencies: Once your environment is set up and activated, install the project dependencies. If you're on a development environment, use:

   pip install -r dev-requirements.txt

   For a production environment, use:

   pip install -r prod-requirements.txt

Notes for Non-pyenv Users

If you're not using `pyenv``, you can set up your Python environment using your preferred method, but ensure you are using the Python version specified in the .python-version file to avoid compatibility issues.

Contributing

If you'd like to help work on this project, you're more than welcome to! There's a few things to keep in mind:

• All formatting should adhere to PEP8 guidelines.
• When sending a Pull Request, make sure you follow the instructions of the guidelines in there.
• All tests must pass before the Pull Request can be considered for approval.

Above all, ensure that your coding style matches the existing code in the project.

Getting Help

If you need help with understanding anything, let me (@MasterJ93) know. Or send an issue: whether for a bug, feature request, or linking a Pull Request to one.

Licence

This project is licensed under the MIT License - see the LICENCE for details.

Dependencies' Licenses

This project uses third-party libraries or dependencies, each with their own licenses. See the NOTICE file for more information.