tag-epic/speedcord

Lightweight discord library

Speedcord

A simple discord API wrapper made to be easily hacked.

DEPRECATION NOTICE

Speedcord is being superseded by https://github.com/nextsnake/nextcore

Installing

You can install Speedcord from PyPi using the following command:

pip3 install speedcord

It is recommended to pin the version in production as breaking changes might occur

Features

• Simple sharding for larger bots
• Speedier requests to the discord API
• More customizablility

Usage

There are currently few examples, you are free to contribute new examples

• Simple command using the MESSAGE_CREATE listener

Extended usage

Using extensions can make your speedcord development experience much more pleasant. Here's a list of extensions which might help you
Speedian - interactions handler

Contributing

Contributions are more than welcome as long as they follow our contribution guidelines

speedcord's Issues

Typehint the library

Typehint the files so it is easier to develop with in IDEs that support typehinting. This should probably be done using .pyi files

Proper documentation

It would be really nice if we could have some documentation with sphinx autodocs. Lets start small and just create a API reference.

Rewrite readme

Generally having a clearer readme would benefit the project.

values.py doesn't have a newline at the end

At the moment the version updater removes the newline at the end of the file, making style checks fail.

Please read before claiming an issue

If you are claiming a issue and do not finish it within appropriate time the issue will be unclaimed. If this is repeated you may be blacklisted from claiming any issues

Make setup.py not include garbage files

There's a lot of unused files in the output build which increases the size of the library.

Files which should be included
setup.py
speedcord/*
README.md

Change close code log to info from warning

Remove Logs

Even after taking away basicConfig(level=DEBUG) # Comment this out if you don't want to see what's going on behind the scenes
You will still get logs in console. Most of them are Unknown close code received. Close code: None.

Add docstrings to functions missing docstrings

This makes using something like sphinx autodocs easier and using ides like python to create bots a lot faster.

Automated tests

Add some automated tests to make sure that the lib is working

Automatically rescale shards when we get disconnected for invalid shard count

When we reach the 1500 guilds per shard threshold we should automatically start another shard if shard_count is not set.

Add proper gateway ratelimiting

At the moment we have a lock that gets locked for .5s every time something is sent to the gateway.

This should probably be changed to 120/60s.

Note: current way never releases the lock if send_json freezes, leaving that shard in a frozen state.

Voice support

We should probably only support heartbeats and sending audio but lets make the bot creator send talking packets and all other stuff.

Add style checks

This should probably be done via flake8 and github actions.