https://github.com/atiep/dpyjs-bot

Bot for the "Discord.py & Discord.js" community
https://github.com/atiep/dpyjs-bot

Last synced: about 2 months ago
JSON representation

Bot for the "Discord.py & Discord.js" community

• Host: GitHub
• URL: https://github.com/atiep/dpyjs-bot
• Owner: AtieP
• Created: 2020-07-22T11:15:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-26T00:40:11.000Z (over 3 years ago)
• Last Synced: 2023-03-10T15:13:09.186Z (almost 2 years ago)
• Language: Python
• Size: 231 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Discord.py & Discord.js Discord Bot

This bot is made specifically for the [Discord.py & Discord.js community.](https://dpyjs.xyz).  

Server template for setting up easier the bot: https://discord.new/J4DTac8XPhFe 

# Setting up the bot

- Install PostgreSQL, and create a database called `dpyjs` with owner `dpyjs`

- Create the tables specified in the `setup-sql.sql` file

- Install Python 3.8+

- Install Pipenv (`pip install pipenv`)

- Install all the packages and dev packages (`pipenv install`, `pipenv install --dev`)

- Create a new file named `config.yml` but with the same contents as `config-default.yml`,

  but changing some of the keys

# Running the bot

- Run `pipenv shell`

- Set up these four enviroment variables: `DPYJS_DATABASE_URL`, `DPYJS_BOT_TOKEN`, `DPYJS_SNEKBOX_URL` and `DPYJS_BAD_WORDS_REGEX`.

  - `DPYJS_BOT_TOKEN` is the bot's token.  

  - `DPYJS_DATABASE_URL` is the database URL, if you made a database named `dpyjs` with

  owner `dpyjs` that is running in `localhost` (127.0.0.1), `postgresql://dpyjs@localhost/dpyjs` is okay.  

  - `DPYJS_SNEKBOX_URL` is required for the public eval command to work. If you want to set up Snekbox, please

  [visit this page](https://github.com/python-discord/snekbox).  

  - `DPYJS_BAD_WORDS_REGEX` is a regular expression with bad words.

- Run `pipenv run start`

# Contributing to the bot

- If you propose a code change, please, lint the bot. This is done by running `flake8`.