Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 4.96 KB

README_JP.md

File metadata and controls

97 lines (65 loc) · 4.96 KB

MiPAC

Discord server invite Ruff

Alt

概要

MiPAのCoreとなるライブラリです。

MiPACはMisskey v11, 12, 13をサポートしているApi Wrapperです。 本来気にしないといけないバージョンごとのAPIの違い等を吸収してくれます。

現在大規模な作業を行っています。詳細についてはこちらを御覧ください。 GitHubから何らかの理由でインストールする場合は以下のコマンドで shared ブランチを使用することをおすすめします。 pip install git+https://github.com/yupix/Mi.py.git@shared

サポートしているMisskey

記号の意味

status meaning
〇 動作確認済み、優先的にサポート
△ 動作確認無し、Issue等が来た場合はサポート
× サポートされておらず、使用を想定していない
name version supported
Misskey Official v13 またはそれ以降 〇
Misskey Official v12 △
Misskey Official v11 △

もしあなたが公式リポジトリではなくForkのサーバーを使用していて、正常にMiPACの機能が動作しない場合はIssueにForkのリポジトリと対象のインスタンスURLを送信してください。サポートを行う場合があります。

使い方

MiPACにはPyPiと独自のリポジトリの2つがあります、PyPiは比較的安定してからのリリースになりますが、独自のリポジトリはコミットごとにビルドが行われ公開されるようになっています。

お好きなほうをご利用いただけると幸いです。

https://onedev.akarinext.org/yupix/mipac-sync/MiPAC/~packages

#安定したビルド(推奨)
pip install mipac

#最新の成果物
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)
    await client.http.login()
    api = client.api
    note = await api.note.action.send('Hello World')
    print(note.author.name, note.content)

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

注意事項

一部サーバー(インスタンス)のバージョンによっては正常に動作しない可能性があります

MiPACの特徴として、v11,v12,v13のバージョンごとに生じる変更点をなるべく気にしなくてよいように作成していますが、現状の最新版であるv13でもv13の中で削除されたり、増えたりした物があります。結果的に追従しきれていない箇所があることがあります。そのため、そのような物を見つけた場合は、使用しているサーバーのバージョンと使用できないエンドポイント名をIssueに送信してください。

モデルを自分でインスタンス化することは想定されていません

MiPACのモデルでは多くの場合、キーワード引数に clientを受け取り、それを用いてapi プロパティを生成します。しかし、サポート途中の機能なのではそこが省かれ、リリース後にモデルのインスタンス化に必要な引数として client が追加されることがあります。また、他にもモデルの更新のために引数が変更される可能性があります。そのため、引数の変更に関することをCHANGELOG等で通知することはありません。

LICENSE

MiPAC is provided with MIT LICENSE.

FOSSA Status

Documentation * Discord Server