Introduction¶
Thanks for your interest in this project! Shitcord is a library that aids with creating applications that utilize the Discord API. Let’s have a look at a small introduction to the library.
Prerequisites¶
Shitcord works with Python 3.5.2+. Support for lower versions isn’t supported due to a dependency
(asks
) that doesn’t support any Python versions lower than Python 3.5.2.
Shitcord’s dependencies¶
At this point, we want to say thanks to the developers of a few awesome libraries that Shitcord requires to work.
trio¶
Once upon a time, people thought that asyncio is total bullshit. Then they attempted to create a better asynchronous I/O framework without all the mistakes asyncio made. And trio is the result. It’s a great concurrency framework and is the core of Shitcord. Definitely check it out here.
Installation¶
As this library is still WIP, it isn’t published on PyPI yet. So you can install the most recent version from GitHub:
# Windows:
py -3 -m pip install -U git+https://github.com/itsVale/Shitcord@async#egg=shitcord
# Linux & macOS:
python3 -m pip install -U git+https://github.com/itsVale/Shitcord@async#egg=shitcord
This is the preferred way of installing Shitcord. If you want to use other installation methods, please don’t expect support for the installation of this library.
Warning
If you’re using Python 3.6+ on macOS, please make sure to
run the Install certificates.command
located in the Python folder
inside your Applications
directory. This is important, because
Python 3.6+ comes with its own bundled version of OpenSSL because
Apple only provides deprecated binaries. Without this step, you’re most
likely getting an SSLError whenever you try to run your bot.
Basic Usage¶
As the following documentation is incomplete and the library due to WIP may be changed dramatically at any time, we don’t provide a usage example yet. Also, it is not very user-friendly yet, so better stay patient unless you are willing to read the source code.
1 2 3 4 5 6 7 8 9 10 11 12 | import shitcord
client = shitcord.Client(SomeConfig())
@client.on('message')
async def on_message(message):
if 'owo' in str(message).lower():
await message.respond("What's This?")
client.start()
|
Support¶
If you need help with this library or have a question about how its usage, you could either create an issue on GitHub or, and this is the most preferred way, you join the official support server.