wassname/Open-Assistant
1
0
Fork 0
mirror of https://github.com/wassname/Open-Assistant.git synced 2026-07-07 00:06:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

document code structure

Browse Source
This commit is contained in:
Alex Ott
2022-12-30 05:56:04 -08:00
parent 150fc67bfd
commit aff3f18b07
1 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
discord-bot/CONTRIBUTING.md
+16 -15
View File
@@ -30,31 +30,32 @@ To test the bot on your own discord server you need to register a discord applic
### Structure
Important files
```graphql
.env # Environment variables
.env.example # Example environment variables
CONTRIBUTING.md # This file
dev-requirements.txt # Development requirements
flake8-requirements.txt # Flake8 extensions (for linting)
noxfile.py # Nox session definitions (for formatting, typechecking, linting)
pyproject.toml # Project configuration
README.md # Project readme
EXAMPLES.md # Examples for commands and listeners
requirements.txt # Requirements
templates/ # Message templates
bot/
├─ __init__.py
├─ __main__.py # Entrypoint
├─ bot.py # Main bot class
├─ config.py # Configuration and secrets
├─ utils.py # Utility Functions
├─ __main__.py # Entrypoint
├─ api_client.py # API Client for interacting with the backend
├─ bot.py # Main bot class
├─ settings.py # Settings and secrets
├─ utils.py # Utility Functions
│
├─ db/ # Database related code
│ ├─ database.db # SQLite database
│ └─ schema.sql # Database schema
├─ db/ # Database related code
│ ├─ database.db # SQLite database
│ ├─ schema.sql # SQL schema
│ └─ schemas.py # Python table schemas
│
└── extensions/ # Application logic, see https://hikari-lightbulb.readthedocs.io/en/latest/guides/extensions.html
└─ hot_reload.py # Utility for hot reload extension
└── extensions/ # Application logic, see https://hikari-lightbulb.readthedocs.io/en/latest/guides/extensions.html
├─ work.py # Task handling logic <-- most important file
├─ guild_settings.py # Server specific settings
└─ hot_reload.py # Utility for hot reload extensions during development
```
### Adding a new command/listener