Discord templating engine built on discord.py, to help separate text of embeds from the source code. Inspired by Flask.
Key Features:
- use of xml files to hold the various template responses
- allows for pagination, in an abstract form simplifying the interface in the source code
:gear: Installing:
Python3.8 or higher is required
:test_tube: Tests
To run the tests, run the following command in the root directory:
Windows:
python -m unittest tests -v
Linux:
python3 -m unittest tests -v
:zap: Usage
This is explained in more detail in the wiki
Wrap expressions that need to evaluated with {}, such as {player.name} or {todays_date}
Sample XML file:
<discord>
<message key="test_key">
<embed>
<title>Test</title>
<description>Test Description</description>
<colour>magenta</colour>
<timestamp format="%Y-%m-%d %H:%M:%S.%f">{todays_date}</timestamp>
<url>https://www.discord.com</url>
<fields>
<field>
<name>Test Field</name>
<value>Test Text</value>
</field>
</fields>
<footer>
<text>Test Footer</text>
<icon>https://cdn.discordapp.com/embed/avatars/0.png</icon>
</footer>
<thumbnail>https://cdn.discordapp.com/embed/avatars/0.png</thumbnail>
<image>https://cdn.discordapp.com/embed/avatars/0.png</image>
<author>
<name>Test Author</name>
<icon>https://cdn.discordapp.com/embed/avatars/0.png</icon>
<url>https://discordapp.com</url>
</author>
</embed>
<view>
<components>
<button key="understood_button">
<label>Understood</label>
<style>success</style>
</button>
</components>
</view>
</message>
</discord>
using the above xml file, for example, you can create an embed with the following code:
import datetime
from typing import Literal
import discord
from discord.ext import commands
import qalib
from qalib.template_engines import formatter
bot = commands.AutoShardedBot(command_prefix="!", intents=discord.Intents.all())
Messages = Literal["test_key"]
async def acknowledged(interaction: discord.Interaction):
await interaction.response.send_message("Acknowledged", ephemeral=True)
@bot.command()
@qalib.qalib_context(formatter.Formatter(), "templates/test.xml")
async def test(ctx: qalib.QalibContext[Messages]):
callables = {"understood_button": acknowledged}
await ctx.rendered_send("test_key", callables, keywords={
"todays_date": datetime.datetime.now()
})
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file discord_qalib-2.5.14.tar.gz.
File metadata
- Download URL: discord_qalib-2.5.14.tar.gz
- Upload date:
- Size: 30.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5902cafec5f829e64f58fff8c1352c01bf747d50e01dd38c18aae49de2261f2d
|
|
| MD5 |
3804ad9f29da583b0cca0112487d82c7
|
|
| BLAKE2b-256 |
17cde945b756bd407df76455fe6028cbcc7086497d66e52c5a85ba5cbfc84e18
|
Provenance
The following attestation bundles were made for discord_qalib-2.5.14.tar.gz:
Publisher:
twine-publish.yml on YousefEZ/discord-qalib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
discord_qalib-2.5.14.tar.gz -
Subject digest:
5902cafec5f829e64f58fff8c1352c01bf747d50e01dd38c18aae49de2261f2d - Sigstore transparency entry: 833788827
- Sigstore integration time:
-
Permalink:
YousefEZ/discord-qalib@f955dc77322f7f6b9afa06b55b37d903a2c8b9a2 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/YousefEZ
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
twine-publish.yml@f955dc77322f7f6b9afa06b55b37d903a2c8b9a2 -
Trigger Event:
pull_request
-
Statement type:
File details
Details for the file discord_qalib-2.5.14-py3-none-any.whl.
File metadata
- Download URL: discord_qalib-2.5.14-py3-none-any.whl
- Upload date:
- Size: 39.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
67a712fe503566bfd4dc3cc29c26a75acf6c612d4bfc7d707beaa4747f8df75f
|
|
| MD5 |
b4badf92ab83244c87f12a99972899e1
|
|
| BLAKE2b-256 |
897bde9ba043a6c1285fc7cf3a7fda60a60c52966503d50ae7fdf446b41e1f32
|
Provenance
The following attestation bundles were made for discord_qalib-2.5.14-py3-none-any.whl:
Publisher:
twine-publish.yml on YousefEZ/discord-qalib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
discord_qalib-2.5.14-py3-none-any.whl -
Subject digest:
67a712fe503566bfd4dc3cc29c26a75acf6c612d4bfc7d707beaa4747f8df75f - Sigstore transparency entry: 833788828
- Sigstore integration time:
-
Permalink:
YousefEZ/discord-qalib@f955dc77322f7f6b9afa06b55b37d903a2c8b9a2 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/YousefEZ
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
twine-publish.yml@f955dc77322f7f6b9afa06b55b37d903a2c8b9a2 -
Trigger Event:
pull_request
-
Statement type:
