release v0.6.0

.github/CONTRIBUTING.md

@@ -17,10 +17,22 @@ Check the going points before creating an assignment
 - `develop` is the branch to work on for the next release
     - If you want to create a pull request, please send it to this branch
 
+## Building a Development Environment
+
+```
+python -m venv .venv
+
+# after activate env
+
+pip install -r requirements.txt -r requirements-dev.txt
+
+pre-commit install
+```
+
 ## Creating a pull request
 
 - Create an Issue before creating a pull request.
-- Please prefix the branch name with a keyword such as `feat` / `fix` / `refactor` / `chore` to identify the pull request as much as possible.  
+- Please prefix the branch name with a keyword such as `feat` / `fix` / `refactor` / `chore` to identify the pull request as much as possible.
     - Also, do not include changes other than to resolve the pull request issue
 - If you have an Issue that will be resolved by a pull request, please include a link
 - Any changes should be described in `CHANGELOG.md`. However, if there is no change from the user's point of view, there is no need to describe it.
@@ -38,3 +50,42 @@ This project uses `axblack` and `isort` formatting. The difference between `axbl
 
 - Ayuskey v5, 6
 - Misskey v13, 12, 11
+
+### 引数に関する例外について
+
+Misskey側に渡すBodyにおいて、例えば `limit` に渡せる最大数が100だと分かっていても、MiPAC側で特別なことはしないものとする。これはAPIを叩いた際に帰ってくるエラーをより直接的に見れるようにするためです
+
+### 引数のデフォルト値について
+
+少し複雑な話になる為例を出しつつの説明になります。
+例として `/api/channels/update` には `isSensitive` や `bannerId` といったキーを渡すことができます。では `update` メソッドを実際に作ってみましょう。
+
+```python
+    async def update(
+        self,
+        banner_id: str | None = None,
+        is_sensitive: bool | None = None,
+    ) -> :
+    ...
+```
+
+まず、 `is_sensitive` に `None` が選べてしまうのは何か気持ち悪い所があります。次に`banner_id` は エンドポイント側がnullを許容している為、既に `banner_id` が設定してあった場合、`is_sensitive` のみを更新しようとした場合にnullに設定されてしまいます。また、`request` メソッドが持つ `remove_none=True` でNoneを消すことができますが、これでは `banner_id` を nullにする方法がなくなってしまします。
+
+では、ここで`MISSING` を使って書き直します。
+
+```python
+    async def update(
+        self,
+        banner_id: str | None = MISSING,
+        is_sensitive: bool = MISSING,
+    ) -> :
+    data = remove_dict_missing({
+        "bannerId": banner_id,
+        "isSensitive": is_sensitive
+    })
+    self._session.request(Route("POST", "/api/channels/update"), auth=True, json=data, remove_none=False)
+    ...
+```
+
+`is_sensitive` のTypeHintsが `bool` のみにできるので気持ち悪さが解消されます。
+また、 `remove_dict_missing` を使用することで `MISSING` のみを削除出来るため、Noneに設定したい場合は `await update(banner_id=None)` とすることで `banner_id` を null に設定できるようになります。注意点として、 `request` メソッドの `remove_none=False` に設定しないと `None` が削除されてしまうため気を付けてください。基本的に `/api/channels/create` のように作成系等では既にサーバー上にあるデータに留意する必要が無いため、`MISSING` ではなく `None` を使用しても問題ないです

.github/ISSUE_TEMPLATE/support_new_endpoint_request.md

@@ -0,0 +1,20 @@
+---
+name: ✨ Support new endpoint request
+about: Suggest an idea
+title: ''
+labels: kind/Feature✨, topic/API🧩, Actions⚙, Manager📦
+assignees: yupix
+
+---
+
+## Summary
+
+<!-- Tell us what the suggestion is -->
+
+## Work
+
+- [ ] v11 support
+- [ ] v12 support
+- [ ] v13 support
+
+

.github/workflows/code_quality.yml

@@ -0,0 +1,24 @@
+name: Qodana
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: "**"
+
+
+jobs:
+  qodana:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      checks: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}  # to check out the actual pull request commit, not the merge commit
+          fetch-depth: 0  # a full history is required for pull request analysis
+      - name: 'Qodana Scan'
+        uses: JetBrains/qodana-action@v2023.3
+        env:
+          QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

.github/workflows/doc_build.yml

@@ -0,0 +1,37 @@
+name: Document Release
+on:
+  push:
+    branches:
+    - develop
+
+jobs:
+  release:
+    name: Build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.12]
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+
+    - name: Setup Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install Package
+      run: |
+        pip install -e .[doc]
+
+    - name: Build Docs
+      run: python doc_gen.py
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html
+        cname: mipac.akarinext.org

.github/workflows/python-app.yml

@@ -7,26 +7,25 @@ on:
   push:
     branches: "**"
   pull_request:
-    branches: [ "master" ]
+    branches: ["master"]
 
 permissions:
   contents: read
 
 jobs:
   type-check:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v3
-      with:
-        python-version: "3.11"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install . .[ci]
-    - name: Lint with flake8
-      run: |
-        flake8 mipac
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install . .[ci]
+      - name: Lint with ruff
+        run: |
+          ruff check mipac

.github/workflows/python-publish.yml

@@ -25,7 +25,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
-        python-version: '3.11'
+        python-version: '3.12'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.gitignore

@@ -5,4 +5,5 @@ __pycache__
 build
 dist
 .idea
-docs/_build
+docs/_build
+.env

.onedev-buildspec.yml

@@ -0,0 +1,62 @@
+version: 26
+jobs:
+- name: Publish Packages(OneDev)
+  steps:
+  - !CheckoutStep
+    name: checkout
+    cloneCredential: !DefaultCredential {}
+    withLfs: false
+    withSubmodules: false
+    cloneDepth: 2000
+    condition: ALL_PREVIOUS_STEPS_WERE_SUCCESSFUL
+  - !CommandStep
+    name: publish artifact
+    runInContainer: true
+    image: python:3.12.2-slim
+    interpreter: !DefaultInterpreter
+      commands:
+      - apt update
+      - apt install -y git
+      - ''
+      - git fetch
+      - ''
+      - cat << EOF > $HOME/.pypirc
+      - '[distutils]'
+      - index-servers=
+      - '  onedev'
+      - ''
+      - '[onedev]'
+      - repository=https://onedev.akarinext.org/yupix/mipac-sync/MiPAC/~pypi
+      - username=@job_token@
+      - password=@secret:access-token@
+      - EOF
+      - ''
+      - python -m pip install --upgrade pip
+      - pip install build twine
+      - ''
+      - python -m build
+      - ''
+      - twine upload --repository onedev dist/*
+    useTTY: true
+    condition: ALL_PREVIOUS_STEPS_WERE_SUCCESSFUL
+  triggers:
+  - !BranchUpdateTrigger {}
+  retryCondition: never
+  maxRetries: 3
+  retryDelay: 30
+  timeout: 3600
+- name: Sync
+  steps:
+  - !PushRepository
+    name: Push GitLab
+    remoteUrl: https://lab.teamblackcrystal.com/yupix/MiPAC
+    userName: yupix
+    passwordSecret: gitlab-access-token
+    force: true
+    condition: ALL_PREVIOUS_STEPS_WERE_SUCCESSFUL
+  triggers:
+  - !BranchUpdateTrigger {}
+  retryCondition: never
+  maxRetries: 3
+  retryDelay: 30
+  timeout: 3600

.pre-commit-config.yaml

@@ -1,11 +1,20 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-- repo: https://github.com/pycqa/isort
-  rev: 5.10.1
-  hooks:
-    - id: isort
-- repo: https://github.com/axiros/axblack
-  rev: 5f011e46362b8680d686cb7918e849e4cb17e826
-  hooks:
-    - id: black
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.2
+    hooks:
+    -   id: ruff
+        args: [ --fix ]
+    -   id: ruff-format
+-   repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.351
+    hooks:
+    -   id: pyright