You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
yupix 4d7ff4a59e
Merge pull request #109 from yupix/develop
4 months ago
.github docs: update CONTRIBUTING.md 4 months ago
.vscode 🔧 feat: vscodeで使用できるsnippetsを追加 1 year ago
compiler chore: format 4 months ago
docs docs: update rst & po 4 months ago
mipac fix: circular import 4 months ago
utils fix: ネストしたフォルダ構造でインポートが壊れる 4 months ago
.editorconfig feat: .editorconfigを追加 2 years ago
.flake8 🎨 feat: 最大文字数をpep8の最大である99まで緩和 1 year ago
.gitattributes feat: python-versioneerを追加 2 years ago
.gitignore chore: update .gitignore 8 months ago
.onedev-buildspec.yml ci: gitlabへのpushはforceで行うように 4 months ago
.pre-commit-config.yaml feat: pre commitを使用するように 4 months ago
CHANGELOG.md feat: release v0.6.0 4 months ago
LICENSE chore: add LICENSE 2 years ago
MANIFEST.in feat: python-versioneerを追加 2 years ago
README.md docs: update README.md 4 months ago
README_JP.md docs: update README.md 4 months ago
doc_gen.py fix: doc_genがwindowsだと\なせいで動かない 7 months ago
pyproject.toml feat: MiAuth用のユーティリティクラスを追加 4 months ago
requirements-dev.txt feat: pre commitを使用するように 4 months ago
requirements.txt chore: python3.12に向けて色々変更 5 months ago
setup.cfg feat: python-versioneerを追加 2 years ago
setup.py fix: setup install 4 months ago
versioneer.py feat: python-versioneerを追加 2 years ago

README.md

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

Supported Misskey

Indicators of support

status meaning
Operation verified, priority support
confirmation of operation, add support for features as and when issues, etc. come in.
× Not supported and not intended for use
name version supported
Misskey Official v13 or later
Misskey Official v12
Misskey Official v11

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)
    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())

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