Python Utility Bot

This project is a Discord bot specifically for use with the Python Discord server. It provides numerous utilities and other tools to help keep the server running like a well-oiled machine.

Requirements

• Git
• Docker
• Docker-Compose
  • pip install docker-compose
• Pipenv
  • pip install pipenv

Setup Reference (temporary)

1. Read the Contributing guidelines.
2. Clone the repository to a suitable working project directory using git clone.
   • If you are not a core developer, you will need to fork pythondiscord/bot.
3. Create a copy of config-default.yml named config.yml and edit the configuration options.
   • This is to be replaced with different instructions in future due to upcoming config updates.
4. Create an empty .env in the same top-level project directory and add:
   • BOT_TOKEN=yourdiscordbottoken
   • If you have a development site setup already, get the docker project name and add in .env:
     • COMPOSE_PROJECT_NAME=site, adjusting site to match the other project name.
5. Install development dependancies for your IDE/editor/linting:
   • pipenv sync --dev
6. Run the compose:
   • If you're running a full development site setup already, run:
     • docker-compose up bot
   • Otherwise, run:
     • docker-compose up