khl.py 0.1.1

Python SDK for kaiheila.cn API

> 加入我们的 khl 服务器 | Join our server on khl

special notes for v0.1.0

v0.1.0 is a breaking version with better architecture, simpler API, more powerful components etc.

if you do not want to migrate existing code, please stay at v0.0.10

by the way, have a try on v0.1.0 is a piece of cake, and we wanna your feedback or help(if you are willing to)

khl.py

Python SDK for kaiheila.cn API

install

Python requirement: >= Python 3.6

pip install khl.py

quickly enroll

Minimal example:

from khl import Bot, Message

# init Bot
bot = Bot(token='xxxxxxxxxxxxxxxxxxxxxxxxx')


# register command, send `/hello` in channel to invoke
@bot.command(name='hello')
async def world(msg: Message):
    await msg.reply('world!')


# everything done, go ahead now!
bot.run()
# now invite the bot to a server, and send '/hello' in any channel
# (remember to grant the bot with read & send permissions)

For more example and tutorial, please turn to example

notes for Mac OSX users:

if you encounter this error:

ssl.SSLCertVerificationError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1123)

please install certificate manually, turning to this post for guide:

certificate verify failed: unable to get local issuer certificate

short-term roadmap

feat

• card message
  • default colors
• helper function for apis

CONTRIBUTION

welcome! we are glad to get help from community hands, and don't be shy to show your code, we can improve it together even if it's not perfect right now

if there is any bug/perf/feature request, we are willing to deal with your issue/pull request!

the only red tape:

only accept commits satisfying Conventional Commits convention

search plugins with keyword commitizen for your editor/IDE, then addict to write commit message