Project Structure

[kzndotsh]

Traditional python project structures:

https://docs.python-guide.org/writing/structure/
https://dagster.io/blog/python-project-best-practices
https://medium.com/mlearning-ai/a-practical-guide-to-python-project-structure-and-packaging-90c7f7a04f95
https://github.com/pypa/sampleproject
https://www.pythonbynight.com/blog/starting-python-project
https://realpython.com/python-application-layouts/
https://waterprogramming.wordpress.com/2023/01/18/structuring-a-python-project-recommendations-and-a-template-example/
https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/
https://carlosgrande.me/my-python-project-cheatsheet/
https://www.the-analytics.club/python-project-structure-best-practices/
https://www.w3docs.com/snippets/python/what-is-the-best-project-structure-for-a-python-application.html
https://awaywithideas.com/the-optimal-python-project-structure/
https://dev.to/codemouse92/dead-simple-python-project-structure-and-imports-38c6
https://github.com/yngvem/python-project-structure

[kzndotsh]

Discord bot project structures:

https://www.reddit.com/r/Discordjs/comments/vckdo4/project_structure_bot_api_react_client/
https://dev.to/itsnikhil/architecting-discord-bot-the-right-way-383e
https://github.com/antoinemcx/Structure-Discord-Bot
https://github.com/python-discord/bot
https://github.com/Just-Some-Bots/MusicBot
https://github.com/Zero6992/chatGPT-discord-bot
https://github.com/staciax/Valorant-DiscordBot
https://github.com/kkrypt0nn/Python-Discord-Bot-Template
https://github.com/AlexFlipnote/discord_bot.py
https://github.com/Darkempire78/Raid-Protect-Discord-Bot
https://github.com/modmail-dev/Modmail
https://github.com/Column01/Discord-Moderation-Bot
https://github.com/nh-server/Kurisu
https://github.com/engineer-man/piston-bot
https://github.com/thomas-xin/Miza
https://github.com/joinemm/miso-bot
https://github.com/RedCokeDevelopment/Teapot.py
https://github.com/quotientbot/Quotient-Bot
https://github.com/interactions-py/interactions.py
https://github.com/finlaysawyer/discord-uptime
https://github.com/CyberDiscovery/cyberdisc-bot
https://github.com/QiCuiHub/discord-audio-pipe
https://github.com/NullPxl/NullCTF
https://github.com/Adikso/BashBot
https://github.com/discordsuperutils/discord-super-utils
https://github.com/hfz1337/Eruditus
https://github.com/GitBolt/axiol
https://github.com/XNBlank/sudoBot
https://github.com/hackthebox/Hackster
https://github.com/egeyardimci/Discord-Py-Bot-Template
https://github.com/Skelmis/Discord-Anti-Spam
https://github.com/Defxult/discordLevelingSystem
https://github.com/Hecate946/Neutra
https://github.com/joshsand/Pojo
https://www.reddit.com/r/learnpython/comments/5vrnta/how_and_when_should_you_organize_a_project_into/
https://www.codedex.io/projects/build-a-discord-bot-with-python
https://codeburst.io/discord-py-the-quickstart-guide-2587abc136ab
https://codepal.ai/makefile-writer/query/amYkDVNx/makefile-for-discord-boost-bot

[arutonee1]

I'm personally a fan of maximizing modularity like so:

.
+-tux/
| +-fun/
| | +-bar.py
| | +-baz.py
| +-moderation/
| | +-bar.py
| | +-baz.py
| +-startup.py
+-main.py
+-venv
+-.env

where each category of bot features makes a parent module and each feature makes a submodule.

Very few Discord bots actually use this model or something similar, which could be related to A) some flaw that I'm unaware of or B) the relatively lower scope of mentioned open-source bots. I hope its B, but if anyone finds a problem with the module system, please reach out.

[jwe66]

how do you like this? heavily inspired by the file structure of https://github.com/unixporn/robbb/

EDIT: I have taken my ADHD meds and redone my file structure again

.
├── out                            # Compiled and generated output
│   ├── tux.pyc                    # Compiled Python file
│   ├── data
│   │   └── AUTHENTICATION_TOKEN   # File containing authentication token
├── tux
│   ├── tux_events                 # Root package/module
│   │   ├── events                 # Package for event handling
│   │   │   ├── on_leave.py        # Module handling leave events
│   │   │   └── on_join.py         # Module handling join events
│   │   └── event_handler.py       # Module for main event handling logic
│   ├── tux_commands               # Package for custom commands
│   │   ├── command_1.py           # Module for the first custom command
│   │   └── command_2.py           # Module for the second custom command
│   ├── tux_util                   # Package for utility modules
│   │   ├── db.py                  # Module for database-related utilities
│   │   ├── permissions.py         # Parser for /config/settings.ini file 
│   │   └── auto_complete.py       # Module for auto-complete utilities
│   ├── permissions.py             # Parser for /config/settings.ini file  
│   └── main.py                    # Main entry point for the application
├── tests                          # Directory for testing files
│   ├── test_event_handler.py      # Test file for event handling
│   └── test_commands.py           # Test file for custom commands
├── config                         # Configuration directory
│   └── settings.ini               # Configuration file
├── logs                           # Directory for log files
│   └── application.log            # Log file
├── .venv                          # Virtual environment directory
├── .gitignore                     # Git ignore file
├── README.md                      # Project documentation
├── pyproject.toml                 # Poetry project metadata
└── poetry.lock                    # Poetry dependency lock file

[kzndotsh]

Chatgpt additions:

The project structure you have is already well-structured and follows good practices. However, there are a few things that could potentially be improved or added, depending on the needs of your project:

1. Environment Variables: If your bot uses sensitive data such as API keys, it's a good practice to store them in a .env file which doesn't get committed to the repository. Then, use a library like python-dotenv to load these variables into the environment.

2. Middleware Package: If your bot uses middleware for handling things like pre-processing or error handling, it could be useful to create a dedicated package for this code.

3. Cogs/Extensions Directories: Discord bots built using libraries such as discord.py often make use of Cogs or Extensions for organizing different features of the bot. These are essentially mini-packages which contain a group of related commands and/or event listeners, and are loaded/unloaded dynamically. In your current structure, this idea may be reflected in some of the existing packages, but it could be worth considering a reorganization to more directly align with this pattern.

4. Docs Folder: If your bot is complex, consider adding a "docs" folder and use a tool such as Sphinx to generate comprehensive documentation for your bot.

5. Migrations Folder: If your bot uses a relational database which needs to keep track of schema changes over time, consider adding a "migrations" folder.

6. Scripts Folder: If there are scripts that aid in managing the bot (like database seeds, deploy scripts, etc.), a folder could be added for these.

       ├── scripts
       │   ├── deploy.sh           # Deploy script
       │   └── seed_db.py          # Database seed script

7. Dockerization: Consider Dockerizing your bot. Docker helps in dealing with dependencies in a systematic way and makes deployment easier. For that you need to add a Dockerfile in your root directory.

8. Add a License File: If your bot is open source, you should have a LICENSE file in the root of your repository.

9. Contributing Guidelines: If others are working on the bot, or you want to encourage others to contribute, consider adding CONTRIBUTING.md guidelines.

Remember, the best project structure will often depend on the specific needs and logistics of your project, so not all of these suggestions may be necessary or useful in your case.

[jwe66]

do we wanna do makefiles instead?

[jwe66]

How do you guys feel about deploying our code through docker? it could really streamline deployment. This would allow anyone and everyone who wants to help contribute to be able to do so with as little mental overhead as possible.

[kzndotsh]

tux/
├─ .git/
├─ .venv/
├─ config/
│  ├─ settings.json
├─ docs/
│  ├─ DOCS.md
├─ logs/
│  ├─ application.log
├─ scripts/
│  ├─ seed_db.sh
├─ src/
│  ├─ commands/
│  │  ├─ quick_ban.py
│  ├─ events/
│  │  ├─ on_message.py
│  ├─ utils/
│  │  ├─ completions.py
│  │  ├─ db.py
│  │  ├─ event_handler.py
│  │  ├─ permissions.py
│  ├─ main.py
├─ tests/
│  ├─ commands/
│  │  ├─ test_quick_ban.py
│  ├─ events/
│  │  ├─ test_on_message.py
│  ├─ utils/
│  │  ├─ test_permissions.py
├─ .env
├─ .gitignore
├─ .pre-commit-config.yaml
├─ docker-compose.yml
├─ LICENSE.md
├─ Makefile
├─ poetry.lock
├─ pyproject.toml
├─ README.md
├─ requirements.txt

my proposed structure

[kzndotsh]

tux/
├─ .git/
├─ .venv/
├─ config/
│  ├─ settings.json
├─ docs/
│  ├─ DOCS.md
├─ logs/
│  ├─ application.log
├─ scripts/
│  ├─ seed_db.sh
├─ tux/
│  ├─ commands/
│  │  ├─ quick_ban.py
│  ├─ events/
│  │  ├─ on_message.py
│  ├─ utils/
│  │  ├─ completions.py
│  │  ├─ db.py
│  │  ├─ permissions.py
│  │  ├─ tux_logger.py
│  ├─ main.py
│  ├─ event_handler.py
├─ tests/
│  ├─ commands/
│  │  ├─ test_quick_ban.py
│  ├─ events/
│  │  ├─ test_on_message.py
│  ├─ utils/
│  │  ├─ test_permissions.py
├─ .env
├─ .gitignore
├─ .pre-commit-config.yaml
├─ docker-compose.yml
├─ LICENSE.md
├─ Makefile
├─ poetry.lock
├─ pyproject.toml
├─ README.md
├─ requirements.txt