Orca
Orca is an extensive and extendable Python 3.x library for the Discord API. orca boasts the following major features:
- Expressive, functional interface that gets out of the way
- Built for high-performance and efficiency
- Configurable and modular, take the bits you need
- Full support for Python 3.x
- Evented networking and IO using Gevent
Fork
Orca is a maintained fork of disco
Installation
Orca was built to run both as a generic-use library, and a standalone bot toolkit. Installing orca is as easy as running pip install orca.py, however some extra packages are recommended for power-users, namely:
| Name | Reason |
|---|---|
| requests[security] | adds packages for a proper SSL implementation |
| ujson | faster json parser, improves performance |
| erlpack (2.x), earl-etf (3.x) | ETF parser run with the --encoder=etf flag |
| gipc | Gevent IPC, required for autosharding |
Examples
Simple bot using the builtin bot authoring tools:
from orca.bot import Bot, Plugin
class SimplePlugin(Plugin):
# Plugins provide an easy interface for listening to orcard events
@Plugin.listen('ChannelCreate')
def on_channel_create(self, event):
event.channel.send_message('Woah, a new channel huh!')
# They also provide an easy-to-use command component
@Plugin.command('ping')
def on_ping_command(self, event):
event.msg.reply('Pong!')
# Which includes command argument parsing
@Plugin.command('echo', '<content:str...>')
def on_echo_command(self, event, content):
event.msg.reply(content)
Using the default bot configuration, we can now run this script like so:
python -m orca.cli --token="MY_DISCORD_TOKEN" --run-bot --plugin simpleplugin
And commands can be triggered by mentioning the bot (configured by the BotConfig.command_require_mention flag):
255 Dec 28, 2022
41 Dec 14, 2022
2.3k Dec 31, 2022
977 Jan 5, 2023
7 Oct 13, 2021
4 Feb 27, 2022
4 Nov 5, 2021
1 Nov 18, 2021
130 May 28, 2022
11 Dec 14, 2022
1 Jan 2, 2022
1 Dec 19, 2021
75 Jan 4, 2023
1 Jan 16, 2022
60 Jan 3, 2023
2 Feb 28, 2022
1 Nov 18, 2021
2 Nov 29, 2021
10.4k Dec 31, 2022