Package: smalld
SmallD.pySmallD aims to be a minmalist client for the Discord API. It aims to let you use the Discord API, without hiding or abstracting it.Table of ContentsInstallingGetting StartedGuideCreating and ConfiguringRunningGateway EventsResourcesErrorsContactContributingDevelopingUsagesInstallingSmallD can be install from pip.$pipinstallsmalldGetting StartedAfterinstallingSmallD, and we have abot token for discord, we can get started on
making a bot.
This section will guide you through the creation of a Ping bot.
When someone types "++ping", it will respond with "pong".To begin with, we import the SmallD class and create an instance of it.fromsmalldimportSmallDsmalld=SmallD()This is also where we could set the bot token or other configuration options.
By default the bot token will be read from the environment variableSMALLD_TOKEN.
We will set that when running our bot later.Next, we want to add the ability to respond to messages.
To do this we want to listen for message create events from discord, and then send
a response if we received "++ping".
We do  receive events by using a decorator on a function.
We can use different decorators based upon what events we want to list.@smalld.on_message_createdefon_message(msg):passOuron_messagefunction will now be called whenever a message create event is sent by discord.Upon receiving this message we can check for "++ping" as the content by looking at themsg.contentproperty.
If it matches, we now send a message back via the appropriate Discord endpoint.
For sending messages, this is a POST request to "/channels/{channel.id}/messages".
Since we are replaying to the message that was sent, we can get the channel id by usingmsg.channel_id.@smalld.on_message_createdefon_message(msg):ifmsg.content=="++ping":smalld.post(f"/channels/{msg.channel_id}/messages",{"content":"pong"})The last step left in our ping bot is to actually run smalld.smalld.run()When we actually run our script we will need to make sure we pass the token.
We can do this via the command line.$SMALLD_TOKEN=<yourtokenhere>pythonping_bot.pyThe full code for the example can be found in (examples/ping_bot.py).GuideThis section outlines the API provided by SmallD.
It does not aim to outline what are valid payloads, events, etc.
For that, theDiscord developer documentationis
always helpful.Creating and Configuringsmalld.SmallD(token=os.environ.get("SMALLD_TOKEN"),base_url="https://discord.com/api/v6",intents=Intent.all(),shard=(0,1),)Creates a SmallD instance using the provided configuration.
Intents are passed in using the|operator, for exampleIntent.GUILD_MESSAGES | Intent.DIRECT_MESSAGES.
Theshardconfiguration should be a tuple of (current shard, number of shards).RunningSmallD.run()Runs SmallD. Connects to the Gateway, authenticates, and will maintain the connection.
It will handle heartbeats and reconnections as necessary.Gateway Events@SmallD.on_*SmallD.on_*(func=None)@SmallD.on_gateway_payload(op=None,t=None)SmallD.on_gateway_payload(func=None,*,op=None,t=None)To listen to events from the Discord gateway use decorators that start withon_.on_gateway_payloadcan be used to listen for raw payloads, optionally filtering
by the op and/or t fields of the payload.To listen for specific dispatch events, simply useon_followed by the event
you wish to listen for.
For exampleon_message_createfor MESSAGE_CREATE events,on_message_reaction_addfor MESSAGE_REACTION_ADD events, etc.SmallD.send_gateway_payload(data)To send data to the Discord gateway use thesend_gateway_payloadmethod.ResourcesSmallD.<httpmethod>(path,payload="",attachments=None,params=None)SmallD.get(...)SmallD.post(...)SmallD.put(...)SmallD.patch(...)SmallD.delete(...)These methods send a request to a discord resource and return the response.
All methods support the same parameters.
SmallD manages Discord's rate limits, throwing an exception if the rate limit would
be broken. An exception is raised on any non-2xx response.The payload is serialized to JSON before being sent.
Typicallypayloadwill be passed in as adictthat matches the data expected
by the Discord API.Attachments can be provided as a list of tuples.
Each tuple should be (file name, content, mime-type).
The file name and mime-type should be strings, with content being a file-like object.
An example of sending an attachment can be found in (examples/cat_bot.py).Query parameters to be set on the request can be passed inparams.ErrorsclassSmallDError(Exception)classHttpError(SmallDError)classNetworkError(SmallDError)classRateLimitError(SmallDError)SmallDErroris used as a base class for all errors raised by SmallD.HttpErroris raised when a non-2xx response is returned from a resources.
The response that caused the error can be accessed via theresponseattribute.NetworkErroris raised when there is a connectivity or other network related error.RateLimitErroris raised when hitting a Discord imposed rate limit.
The reset time of this rate limit (i.e., when the rate limit will no longer apply) is available in theresetattribute.ContactReach out to theDiscord Projects Hubon Discord and look for the smalld-py channels.ContributingCheckout the issues, and jump right in!
If you have any questions, reach out via the details mentioned inContact.Toxis used for running tests.Runtox -eto run tests with your installed python versionRuntox -e fmtto format the codeEmoji Logis used for commit messages and pull requestsDevelopingTox is used to setup and manage virtual envs when working on SmallD.pyTo run tests:$toxTo run examples, ping_bot in this case:$tox-erun--examples/ping_bot.pyUsagesTsktsk:
A task list aimed at helping prioritize and categorize your tasks.Tweenie:
Add reacts to messages using the power of NLP.SmallD-Click:
A command dispatcher for your discord bot combining Click and SmallD.Converse:
Anonymous (nameless) chat on discord.