Chewing_Bever
/
didier
mirror of https://github.com/stijndcl/didier
0
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix requirements.txt (hopefully) & add some info to FAQ, fixes #47

pull/72/head
Stijn De Clercq 2021-06-19 22:05:31 +02:00
parent 543eb38417
commit 4b6743a51f
4 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
backend/server.py
View File

@ -1,7 +1,6 @@
import json
from discord.ext import ipc from discord.ext import ipc
from functions.database import custom_commands from functions.database import custom_commands
import json
from quart import Quart, jsonify, request from quart import Quart, jsonify, request
from quart_cors import cors from quart_cors import cors
from time import time from time import time

15
faq.md
View File

@ -1,5 +1,14 @@
# FAQ # FAQ
Answers to Frequently Asked Questions. Answers to Frequently Asked Questions and solutions to issues that may arise.
### Table of Contents ## Issues installing dotenv
A list of all questions (in order) so you can easily find what you're looking for.
The name of this package is `python-dotenv`, as listed in `requirements.txt`. The _name_ of the package, however, is just `dotenv`. This confuses PyCharm, which will tell you that you don't have `dotenv` installed as it can't link those two together. You can just click `ignore this requirement` if you don't like the warning.
## Issues installing psycopg2
The `psychopg2` and `psychopg2-binary` packages might cause you some headaches when trying to install them, especially when using PyCharm to install dependencies. The reason for this is because these are `PSQL` packages, and as a result they require you to have `PSQL` installed on your system to function properly.
## Package is not listed in project requirements
This is the exact same case as [Issues installing dotenv](#issues-installing-dotenv), and occurs for packages such as `Quart`. The names of the modules differ from the name used to install it from `pip`. Once again, you can ignore this message.

3
readme.md
View File

@ -51,13 +51,16 @@ When creating a new Didier command, you can add it to a `Category` by adding a d
```python ```python
from decorators import help from decorators import help
from discord.ext import commands
from enums.help_categories import Category from enums.help_categories import Category
from functions import checks
@commands.command(name="Command Name", aliases=["Cn"]) @commands.command(name="Command Name", aliases=["Cn"])
@commands.check(checks.allowedChannels) @commands.check(checks.allowedChannels)
@help.Category(Category.Currency) @help.Category(Category.Currency)
async def command_name(self, ctx): async def command_name(self, ctx):
# Command code # Command code
await ctx.send("Command response")
``` ```
This allows commands across multiple Cogs to be classified under the same category in the help page. This allows commands across multiple Cogs to be classified under the same category in the help page.

6
requirements.txt
View File

@ -1,6 +1,8 @@
python-dotenv==0.14.0 python-dotenv==0.14.0
beautifulsoup4==4.9.1 beautifulsoup4==4.9.1
discord.py==1.7.0 discord.py==1.7.3
git+https://github.com/Rapptz/discord-ext-menus@master
discord-ext-ipc==2.0.0
psycopg2==2.8.5 psycopg2==2.8.5
psycopg2-binary==2.8.5 psycopg2-binary==2.8.5
python-dateutil==2.6.1 python-dateutil==2.6.1
@ -11,3 +13,5 @@ tabulate==0.8.7
yarl==1.4.2 yarl==1.4.2
feedparser==6.0.2 feedparser==6.0.2
googletrans==4.0.0rc1 googletrans==4.0.0rc1
quart==0.6.15
Quart-CORS==0.1.3