Pycordia
⚠️ Note!As of now, this package is under early development so functionalities are bound to change drastically.
We don't recommend you currently use Pycordia in a production environment.
A work-in-progress Discord API wrapper for Python with a simple gateway and some common events implemented.
While there's currently no documentation available, use the examples for guidance. If you have any questions, feel free to join our Discord server to follow the changes we make, as well as receive help and talk with others!
Our examples (and future documentation) assume you're at a level of Python where you can comfortably work with Discord bots.
⚙️
Installation
Pycordia has been well tested on Python 3.8, however, 3.7 and above are supported.
Installing from PIP
The easiest way to get Pycordia on your system is by installing it through pip.
$ pip install pycordia # Should work everywhere
$ pip3 install pycordia # Should work on most *nix systems; use on MacOS
$ python -m pip install pycordia # Alternative; should work everywhere
$ python3 -m pip install pycordia # Alternative; use on MacOS
$ py -3 -m pip install pycordia # Alternative; use on Windows
Installing from Source
If you prefer installing Pycordia from source, proceed with the following:
First, clone this repository either through Git or Github.
Next, proceed to run the setup.py file as in:
$ python setup.py sdist # Should work everywhere
$ python3 setup.py sdist # Should work on most *nix systems; use on MacOS
$ py -3 setup.py sdist # Should work on Windows
cd into the new dist directory and run the created .tar.gz file.
$ pip install pycordia-<version>.tar.gz # Should work everywhere
$ pip3 install pycordia-<version>.tar.gz # Should work on most *nix systems; use on MacOS
$ python -m pip install pycordia-....tar.gz # Alternative; should work everywhere
$ python3 -m pip install pycordia-....tar.gz # Alternative; use on MacOS
$ py -3 -m pip install pycordia-....tar.gz # Alternative; use on Windows
🏓
Example of a simple Ping-Pong Bot
from pycordia import events, models
import pycordia
import dotenv
import os
dotenv.load_dotenv()
client = pycordia.Client(intents=pycordia.Intents.all())
@client.event
async def on_ready(event: events.ReadyEvent):
print(f"{event.user} ready to do stuff!", client.intents)
@client.event
async def on_message_create(msg: models.Message):
if msg.author.bot or not msg.content:
return
if msg.content.startswith(".ping"):
embed = models.Embed.create(description=":ping_pong: Pong!")
embed.color = 0xFF123A
await models.Message.create(client, embeds=[embed]).send(msg.channel_id)
client.run(os.getenv("DISCORD_TOKEN"))
Events
on_ready:events.ReadyEventon_message_create:models.Messageon_typing_start:events.TypingStartEventon_message_delete,on_message_delete_bulk:events.MessageDeleteEventon_message_update:models.Messageon_channel_create,on_channel_update,on_channel_delete:models.Channel
For all other undocumented events, you'll receive raw JSON data which you'll have to handle yourself.
🔖
Things to do
- Improve currently available models
- Add slash commands
- Add all other event wrappers
📖
Contribute
Feel free to contribute any bug fixes, new features, or general improvements to the Pycordia project.
3 Jul 14, 2022
2 Feb 28, 2022
1 Oct 13, 2021
4 Feb 5, 2022
24 Sep 21, 2022
2.9k Jan 2, 2023
3 Oct 9, 2021
4 Nov 8, 2021
3 Nov 28, 2021
12 Aug 31, 2022
1 Jan 13, 2022
3 Jul 17, 2022
14 Jan 11, 2022
3 Aug 7, 2021
1 Sep 20, 2022
3 Jan 16, 2022
1 Mar 14, 2022
10 Mar 5, 2022
4 Feb 18, 2022