Skip to main content

The misskey library for Python. misskey is made by syuilo.

Project description

PRs Welcome MIT License Python test codecov

This script is Python library for Misskey Instance.

This library is only available in Python3.

Misskey is made by syuilo.


How to install

Use pip (Recommend)

pip install Misskey.py
# or
pip3 install Misskey.py

usage

import library (init)

from misskey import Misskey

mk = Misskey("misskey.io")  # Input instance address (If leaved no attribute, it sets "misskey.io")

# Let's note!
mk.notes_create(
    text="Hello Misskey.py!"
)

Use token key

from misskey import Misskey

# If use the token
mk = Misskey("misskey.io", i="abcdef123...")

Create token

from misskey import Misskey, MiAuth

auth = MiAuth("misskey.io", name="misskey.py")
# Get Authentication URL, then send to client browser
url = auth.generate_url()
# After permission granted, run this function
token = auth.check()
# To use misskey.py with created token, please below
misskey = Misskey("misskey.io", i=token)  # or: misskey = misskey("misskey.io", i=auth.token)

Other

Pull requests are HUGE WELCOME!

We hope you will contribute to the completion of the library by all means.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Misskey.py-4.0.0-py3-none-any.whl (11.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page