Merge branch 'release/v3.0.0'

Author: yupix

CHANGELOG.md

@@ -7,6 +7,68 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v3.0.0] 2022-01-23
+
+### Added
+
+- added `ChatManager` class
+- added `RawReaction` class
+- added `RawChat` class
+- added `EmojiManager` class
+- added `FolderManager` class
+- added `DriveManager` class
+- added `text` arg to mention_command
+- added `RawNote` class
+- added `RawRenote` class
+- added `RawEmoji` class
+- added `RawProperties` class
+- added `RawFolder` class
+- added `RawFile` class
+- added `RawPollChoices` class
+- added `RawPoll` class
+- added `RawInstance` class
+- added `RawUserDetails` class
+- added `RawUser` class
+- added `FavoriteManager` class
+- added `FollowManager` class
+- added FollowRequestManager class
+
+### Changed
+
+- updated a examples
+- ドキュメントを更新
+- 内部変更: `UserActions` や `ClientActions` のメソッドを別クラスに分割
+- Allow only property-based access to most data classes.
+- **BREAKING CHANGE**: `User` クラスのプロパティーを以下のように変更
+    - `name` -> `nickname`
+    - `username` -> `name`
+- **BREAKING CHANGE**: `User` クラスの `follow` `unfollow` メソッドを削除
+    - 今後は `User` クラスの `action` メソッドから `add` `remove` メソッドを使用できます
+- **BREAKING CHANGE**: モデル名の変更 `Following` -> `Follower`
+- **BREAKING CHANGE**: モデル名の変更 `Follower` -> `Followee`
+- **BREAKING CHANGE**: モデルの\_state 属性を\_\_state に変更
+- **BREAKING CHANGE**: `Following` クラスのメソッドを以下のとおりに変更
+    - `accept_request` -> `accept`
+    - `reject_request` -> `reject`
+    - `follow` -> `add`
+    - `remove_follow` -> `remove`
+
+## Removed
+
+- Unused class UserDetails
+    - from now on use `RawUserDetails`
+- Unused file view.py
+- **BREAKING CHANGE**: removed `post_note` method
+    - from now on use `self.client.note.send`
+- **BREAKING CHANGE**: removed `note_delete` method
+    - from now on use `self.client.note.delete`
+
+## [v2.1.0-alpha] 2021-12-30
+
+### Fixed
+
+- ドキュメントのバージョン
+
 ## [v2.1.0] 2021-12-30
 
 ### Added
@@ -53,13 +115,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - The following classes no longer inherit from `BaseModel`
-  - Properties
-  - Folder
-  - File
-  - Channel
-  - PinnedNote
-  - PinnedPage
-  - FieldContent
+    - Properties
+    - Folder
+    - File
+    - Channel
+    - PinnedNote
+    - PinnedPage
+    - FieldContent
 - internal change: optimizing import
 - internal change: Renamed `PinnedPage` to `PinnedNote`
 - **BREAKING CHANGE**: Moved the post_note method of ConnectionState to NoteActions
@@ -81,9 +143,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 - add event `on_follow` and `follow_request`
-- add a new `Following` and `UserAction` class
+- add a new `Following` and `UserActions` class
 - add `accept_request` and `reject_request` method to `Following` class
-- add `accept_following_request` and `reject_following_request` method to `UserAction` class
+- add `accept_following_request` and `reject_following_request` method to `UserActions` class
 
 ### Fixed
 
@@ -97,8 +159,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - add `favorite`, `add_to_clips`, `add_reaction` and `remove_favorite` method to `Note` class
 - add `favorite`, `add_note_to_clips`, `add_reaction_to_note` and `remove_favorite` method to `NoteAction` class
 - add class
-  - NoteActions
-  - ClientAction
+    - NoteActions
+    - ClientActions
 
 ### Fixed
 
@@ -110,21 +172,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - `Note` クラスに `reply` メソッドを追加しました
 - 以下のクラスを追加
-  - MisskeyWebSocket
-  - MisskeyClientWebSocketResponse
-  - Route
-  - HTTPClient
+    - MisskeyWebSocket
+    - MisskeyClientWebSocketResponse
+    - Route
+    - HTTPClient
 - Client に以下のメソッドを追加
-  - post_chat
-  - delete_chat
-  - post_note
-    - 今後のノート投稿はこちらを使用してください
-  - delete_note
-  - get_instance
-  - fetch_instance
-  - get_user
-  - fetch_user
-  - upload_file
+    - post_chat
+    - delete_chat
+    - post_note
+        - 今後のノート投稿はこちらを使用してください
+    - delete_note
+    - get_instance
+    - fetch_instance
+    - get_user
+    - fetch_user
+    - upload_file
 - `rich` を使ったデバッグ機能を追加しました
 - `file_upload` 関数を追加しました
 - `run` メソッドに `debug` 引数を追加しました
@@ -141,11 +203,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - api 周りでのエラー出力が分かりやすくなりました
 - ~~今までの `Note` クラスに当たるものを `NoteContent` に変更し別途 `Note` クラスを作成させるようにしました~~
-  - ~~これは不要なデータなどを生成しないようにすることが目的です。~~
+    - ~~これは不要なデータなどを生成しないようにすることが目的です。~~
 - 部分的に Pydantic を廃止
-  - 素直に使わないほうが部分的に楽だから
+    - 素直に使わないほうが部分的に楽だから
 - `Drive` クラスの `upload` メソッドで例外 `InvalidParameters` を発生させるようにしました
-  - これは`to_file`, `to_url` の両方がないと変数が定義されず、`Drive`クラスの生成に失敗する可能性があるからです。
+    - これは`to_file`, `to_url` の両方がないと変数が定義されず、`Drive`クラスの生成に失敗する可能性があるからです。
 - `get_user` メソッドが 非同期になりました。
 - 内部変更: `utils.py` の一部を Cython を用いたものに変更
 - 内部変更: `DriveAction` を廃止し, `file_upload` を使用するように
@@ -163,8 +225,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - **破壊的変更**: `Reaction` クラスと `ReactionContent` を結合させました
 - **破壊的変更**: `Chat` クラスと `ChatContent` を結合させました
 - **破壊的変更**: `Drive` クラスの `upload` メソッドで使用できる引数名を変更、キーワード引数を強制するようにしました。
-  - 引数名の変更は次の通りです `url` => `to_url`, `path` => `to_file`
-  - 強制されるキーワード引数は次の通りです `force`, `is_sensitive`
+    - 引数名の変更は次の通りです `url` => `to_url`, `path` => `to_file`
+    - 強制されるキーワード引数は次の通りです `force`, `is_sensitive`
 
 ### Fixed
 
@@ -175,21 +237,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 
 - `Router` クラスから以下のメソッドを削除しました
-  - main_channel
-  - home_time_line
-  - local_time_line
-  - global_time_line
+    - main_channel
+    - home_time_line
+    - local_time_line
+    - global_time_line
 - クラスの削除について
-  - `ChatContent`
-  - `ReactionContent`
-  - `NoteContent`
-  - `UserAction`
-  - `UserProfile`
-    - `UserProfile`にあったものは `User` に統合され、詳細な情報は `User` クラスの details オブジェクト(`UserDetails`) から取得可能です
+    - `ChatContent`
+    - `ReactionContent`
+    - `NoteContent`
+    - `UserActions`
+    - `UserProfile`
+        - `UserProfile`にあったものは `User` に統合され、詳細な情報は `User` クラスの details オブジェクト(`UserDetails`) から取得可能です
 - **破壊的変更**: `WebSocket` クラスを削除しました
-  - 今後は aiohttp の `ws_connect` メソッドを使用します
+    - 今後は aiohttp の `ws_connect` メソッドを使用します
 - **破壊的変更**: `requests` ライブラリを削除しました
-  - 今後は aiohttp の `request` メソッドを使用します
+    - 今後は aiohttp の `request` メソッドを使用します
 
 ## [v0.2.5] 2021-10-07
 
@@ -209,20 +271,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - **破壊的変更**: `commandFrameWork` を使用しない場合の bot モジュールの名前を client に変更しました
-  - 主にこれは Discord.py に近づけるためと `commandFrameWork` の bot モジュールとの差別化を目的としています
+    - 主にこれは Discord.py に近づけるためと `commandFrameWork` の bot モジュールとの差別化を目的としています
 - `on_mention` イベントの `.text` に自分自身のメンションを含まないように、必要な場合は `content` をご利用ください
 - デフォルトで接続するチャンネルを `globalTimeline` から `main` に変更しました。グローバルタイムラインを見る場合は `Router` をご利用ください
 - `add_poll` の引数位置が変更されています。ご注意ください
 - `delete` メソッドの引数を `_id` -> `note_id` に変更しました
 - 内部変更: `api` 関数で使用されている `data` 引数は非推奨(Deprecated)に代わりに `json_data` を受け取るように
-- 内部変更: `NoteAction` `UserAction` クラスのメソッドを大半を staticmethod に置き換えしました
+- 内部変更: `NoteAction` `UserActions` クラスのメソッドを大半を staticmethod に置き換えしました
 - 内部変更: `Note` クラスのメソッドの依存性を下げました
 - 内部変更: `Follow` をモデルに変更しました
 - 内部変更: イベントの発火に `dispatch` を用いるようになりました。 これにより `bot.py` から各イベントが削除されています
 
 ### Removed
 
-- `UserProfile` クラスから `get_i` を削除しました。今後は`UserAction`から直接ご利用ください
+- `UserProfile` クラスから `get_i` を削除しました。今後は`UserActions`から直接ご利用ください
 - 内部変更: `dispatch` を使うことで `client.py` から `on_message` 等のクラスを削除
 
 ### Fixed
@@ -254,7 +316,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - 内部変更: auth_i の部分を config.i に置き換え
 - `upload`メソッドの引数変更に伴う`add_file`の引数に`is_sensitive`と`force` を追加
 - ほぼすべてのデータ格納用クラスを Pydantic に置き換え( `Note`や`File` など)
-- `get_i`を`UserAction` に移動
+- `get_i`を`UserActions` に移動
 
 ### Removed
 
@@ -351,8 +413,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added Each event method.
 
 [v0.2.5]: https://github.com/yupix/mi.py/compare/v0.1.0-5...v0.2.5
+
 [v0.1.5]: https://github.com/yupix/mi.py/compare/v0.1.0-1a...v0.1.0-5
+
 [v0.1.0-1a]: https://github.com/yupix/mi.py/compare/v0.1.0a...v0.1.0-1a
+
 [v0.1.0a]: https://github.com/yupix/mi.py/compare/v0.0.1a...v0.1.0a
+
 [v0.0.1a]: https://github.com/yupix/Mi.py/releases
+
 [unreleased]: https://github.com/yupix/mi.py/compare/master...HEAD