https://github.com/astraluma/jangle
Framework for creating Discord bots using Django
https://github.com/astraluma/jangle
Last synced: 23 days ago
JSON representation
Framework for creating Discord bots using Django
- Host: GitHub
- URL: https://github.com/astraluma/jangle
- Owner: AstraLuma
- License: agpl-3.0
- Created: 2022-02-17T02:22:11.000Z (about 3 years ago)
- Default Branch: trunk
- Last Pushed: 2022-03-15T04:03:16.000Z (about 3 years ago)
- Last Synced: 2025-02-10T08:30:33.564Z (3 months ago)
- Language: Python
- Size: 177 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jangle
Framework for creating Discord bots using Django.
The goal is to provide a complete framework for creating complex Discord bots,
without the developer having to think about how to wire all the bits and bobs
together. This means supporting realtime events, web UIs, and scheduled
processes, all in the same codebase and sharing a persistance layer. And
allowing for very easy operation of the resulting bot.
Utilizing Django means we have a very mature ORM + Migrations tool, an excellent
web framework, great modularity, and a large ecosystem to pull specialized
features from.
* Uses ASGI for high efficiency and modern features
* Allows using a single daemon for both HTTP and Discord, making for easy deployment
* Integrates into Django's model, allowing for highly modular applications
One of the assumptions is that if your bot is big enough to need horizontal
scaling, you are a strong enough developer to figure out how to add it in.
## prior art
* https://pycord.dev/
* https://github.com/AdvocatesInc/django-channels-discord
## ASGI Messages
* -> `discord.disconnect`: The WebSocket connection was closed. This does not
mean we're shutting down, though--the framework will attempt to reconnect and
resume.
* -> `discord.*`: Discord DISPATCH events are dynamically mapped to message types
Of interest is `discord.ready`, which is sent after authentication has happened
* <- `discord.*`: Sends a message to discord. `type` is mapped to the op code,
and the rest is taken as the data to send.
## Deliverables
* Low-level ASGI stuff
* [x] Discord gateway ASGI server (connects to the Discord Gateway API and connects it to an ASGI app)
* [x] Lifespan multiplexer (allow multiple apps to be connected to lifespan)
* Django-based ASGI app
* [ ] Events: Django Signals or Channels app?
* [ ] Some kind of django-flavored command framework
* [x] Opinions about an in-process cron thingy
* [ ] Utilities to make it easy to wire up everything
* [ ] Opinions about Discord API client
* Should be sync/async (to match current Django)
* Process-wide connection pool
* Way to get a default client authenticated with a configured bot token
* [ ] Opinions about OAuth2 handling & user management
* django-allauth + minimal user
* [ ] Template application to demonstrate the use of all of that