Skip to main content

A Python wrapper for the Misskey API

Project description

MiPAC

Discord server invite Ruff

Alt

Overview

日本語の README もあります

This library is the Core of MiPA.

MiPAC is an Api Wrapper that supports Misskey v11, 12, and 13. It absorbs API differences between versions, etc., which you don't have to worry about originally.

[!IMPORTANT] Extensive work is currently underway. Please see here for more information. If you are installing from GitHub for some reason, we recommend using the shared branch with the following command. pip install git+https://github.com/yupix/Mi.py.git@shared

Support Status

Support status can be found [here](. /compiler/datas/support_status.md). If the endpoint you want to use is not supported, you may create an Issue to get priority support.

If you are using a non-official Fork and it is not working properly, please send us a link to your Fork repository and server in an Issue and we may be able to assist you.

Usage

MiPAC has two repositories, PyPi and its own repository, PyPi is released after it is relatively stable, while the own repository is built and released with each commit.

We hope you will use whichever you prefer. https://onedev.akarinext.org/yupix/mipac-sync/MiPAC/~packages

#stable build(recommended)
pip install mipac

#latest build
pip install --extra-index-url https://onedev.akarinext.org/yupix/mipac-sync/MiPAC/~pypi/simple/ mipac
import asyncio

from mipac.client import Client

async def main():
    client = Client(url, token)
    api = client.api
    note = await api.note.action.send('Hello World')
    print(note.author.name, note.content)

if __name__ == '__main__':
    asyncio.run(main())

Notes

Some server (instance) versions may not work properly.

One of the features of MiPAC is that it is created so that you do not have to worry about the changes that occur in each version of v11, v12, and v13 as much as possible. However, even in v13, which is the current latest version, some items have been removed or increased within v13. As a result, there may be some parts that have not been fully followed. Therefore, if you find such items, please send an Issue with the version of the server you are using and the name of the endpoint that cannot be used.

It is not expected that you will instantiate the model yourself

MiPAC models often take client as a keyword argument and use it to generate the api property. However, since it is a feature in the middle of support, that part may be omitted, and client may be added as a necessary argument to instantiate the model after release. Also, other arguments may be changed to update the model. Therefore, we will not notify you about changes in arguments via CHANGELOG or other means.

LICENSE

MiPAC is provided with MIT LICENSE.

FOSSA Status

Documentation * Discord Server

Project details


Download files

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

Source Distribution

mipac-0.7.4.tar.gz (111.8 kB view details)

Uploaded Source

Built Distribution

mipac-0.7.4-py3-none-any.whl (152.2 kB view details)

Uploaded Python 3

File details

Details for the file mipac-0.7.4.tar.gz.

File metadata

  • Download URL: mipac-0.7.4.tar.gz
  • Upload date:
  • Size: 111.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for mipac-0.7.4.tar.gz
Algorithm Hash digest
SHA256 35ce5e911712a87ec223e217937b2fe7a7d1522b224ade036350a94cafaa49e3
MD5 a33d161a16bade01f8f7e4878f5cd999
BLAKE2b-256 8767c1e8b2b530ff844c9ad01e840df458aa6822efcca8e1ad45ad81111fd909

See more details on using hashes here.

File details

Details for the file mipac-0.7.4-py3-none-any.whl.

File metadata

  • Download URL: mipac-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 152.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for mipac-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3b40f6c14f35a54972b56051f0e8e2ba8b7dc372978f830fda0c067dc3a42851
MD5 06e7f5d004dddc5c20ad73fc1faf02f6
BLAKE2b-256 9d0b05abdad26149cd0333f64d3fd3cd2fae811bb0a9880eac270ed6d82991ab

See more details on using hashes here.

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