yupix
e7350114dd
|
12 months ago | |
---|---|---|
.github | 12 months ago | |
.vscode | 2 years ago | |
compiler | 1 year ago | |
mipac | 1 year ago | |
utils | 1 year ago | |
.editorconfig | 2 years ago | |
.flake8 | 2 years ago | |
.gitattributes | 2 years ago | |
.gitignore | 2 years ago | |
.pre-commit-config.yaml | 2 years ago | |
CHANGELOG.md | 1 year ago | |
LICENSE | 2 years ago | |
MANIFEST.in | 2 years ago | |
README.md | 1 year ago | |
README_JP.md | 1 year ago | |
pyproject.toml | 1 year ago | |
requirements.txt | 2 years ago | |
setup.cfg | 2 years ago | |
setup.py | 1 year ago | |
versioneer.py | 2 years ago |
README.md
MiPAC
Overview
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.
Supported Misskey
name | version | supported |
---|---|---|
Misskey Official | v13, v12, v11 | 〇 |
Ayuskey | v5, v6 | 〇 |
Usage
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
Python 3.12.0 final will be released and the minimum version will be changed to 3.12.0 after 3 months
This is mainly to improve the pace of development of MiPAC by using new syntax and other features to improve DX. Users will also benefit from faster Python and the use of new syntax.
The current release of Python 3.12.0 is listed as follows, so the change will be implemented as early as January 02, 2024.
3.12.0 final: Monday, 2023-10-02
If you have an opinion on this, you can create a Discussion.
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.
Documentation * Discord Server