misspy 2023.10.2

High-performance Misskey API framework

misspy

Misskey API library for Python with StreamingAPI support.

supported software

Misskey forks not listed below are supported only in the latest version provided they are API compatible.

• misskey
• misskey (misskey.io)
• firefish (calckey) (Some APIs may not be compatible with some APIs due to missing documentation regarding firefish API specifications.)

supported misskey versions

This library is developed based on the API specification for Misskey v13 or later, so v12 and earlier are not supported (but you may still be able to use this library).

example

Other examples can be found in the examples directory.

send note

import misspy

mi = misspy.Bot(address, i=token)

Output notes text to the console

import misspy
from misspy.ext import MiAuth
from misspy.hook import hook

bot = misspy.Bot("misskey.io", i=token)

async def on_ready():
    bot.connect("localTimeline")
    print("running")

async def on_note(message):
    print("------------")
    print(message.text)
    print("------------")


hook.add("note", on_note)
hook.add("ready", on_ready)
bot.run()

MiAuth

from misspy.ext import MiAuth

mia = MiAuth("misskey.io")
print(mia.generate_url("example app"))
while True:
    input("enter to continue...")
    try:
        token = mia.check()
        break
    except misspy.MiAuthFailed:
        pass
print(token)

docs

Documentation can be found at: https://docs.misspy.xyz/