General purpose Discord bot for the DeVinci Fablab discord server.
This library is managed with uv, a fast Python package and project manager written in Rust.
Start by installing uv.
While using uv is not mandatory, it is the simplest way to get started with this project. If you know what you're doing feel free to use any other tool.
To create a Virtual Environment for the project and install the dependencies, you can simply use:
uv syncYou will need to create a secrets/ folder into the project root directory and add three files:
secrets/discord_token.secretsecrets/guild_token.secretsecrets/personal_id.secret
Here are some commands to help you create those:
mkdir secrets# Token for authenticating with the Discord API
echo -n 'my_discord_token' > secrets/discord_token.secret
# ID of the Discord guild (server) to connect to (DeVinci Fablab) [Unused ?]
echo -n 'my_personal_id' > secrets/personal_id.secret
# Personal user ID for the Discord bot or user (https://discord.com/developers/applications) [Unused ?]
echo -n 'my_guild_token' > secrets/guild_token.secretTo run the code, you can then use:
uv run src/main.pyWe highly recommend you to read the user guide before using the bot. It will help you understand the bot's features and how to use them. You can find the user guide here.
To build the documentation of a version of this project, you can use the provided doc_builder utility.
uv run doc_builderYou can then open the docs/index.html file in your browser to view the codebase's documentation.
Add the --help flag to this command to see available options.
The library is still in active development. The next feature and bug resolutions are listed in the Project section of the GitHub repository.
Consider reading our SECURITY policy to know more about how we handle security issues and how to report them. You will also find the stable versions of the project.
Consider reading the ACKNOWLEDGMENTS file. It's a testament to the collaborative effort that has gone into improving and refining our library. We're deeply grateful to all our contributors for their invaluable input and the significant difference they've made to the project.
It also lists the open source projects that have been used to build this library until now.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. To do so, follow the steps described in the CONTRIBUTING file.
We are always open for feedback and discussions. If you are using our library and want to share your use case, or if you have any suggestions for improvement, please feel free to open an issue or open a discussion on our GitHub repository. Your input helps us understand possible use cases and make necessary improvements.
Do not hesitate to star and share the project if you like it!
Distributed under the MIT License. See LICENSE for more information.