docとバージョン

Author: kakeruzoku

docs/reference/sites.rst

@@ -32,4 +32,31 @@
 
 .. autoclass:: scapi.ProjectFeatured
 
-.. autoclass:: scapi.ProjectVisibility
+.. autoclass:: scapi.ProjectVisibility
+
+スタジオ
+-------------------------
+
+.. autofunction:: scapi.get_studio
+
+.. autofunction:: scapi.Session.get_studio
+    :no-index:
+
+.. autoclass:: scapi.Studio
+
+.. autoclass:: scapi.StudioStatus
+
+ユーザー
+-------------------------
+
+.. autofunction:: scapi.get_user
+
+.. autofunction:: scapi.Session.get_user
+    :no-index:
+
+.. autoclass:: scapi.User
+
+コメント
+-------------------------
+
+.. autoclass:: scapi.Comment

scapi/__init__.py

@@ -20,6 +20,7 @@
 
 from .sites.studio import (
     Studio,
+    StudioStatus,
     get_studio
 )
 

scapi/sites/studio.py

@@ -10,6 +10,22 @@
 )
 
 class Studio(base._BaseSiteAPI[int]):
+    """
+    スタジオを表す
+
+    Attributes:
+        id (int): スタジオのID
+        title (common.MAYBE_UNKNOWN[str]): スタジオの名前
+        host_id (common.MAYBE_UNKNOWN[int]): スタジオの所有者のユーザーID
+        description (common.MAYBE_UNKNOWN[str]): スタジオの説明欄
+        open_to_all (common.MAYBE_UNKNOWN[bool]): 誰でもプロジェクトを追加できるか
+        comments_allowed (common.MAYBE_UNKNOWN[bool]): コメント欄が開いているか
+
+        comment_count (common.MAYBE_UNKNOWN[int]): コメントの数(<=100)
+        follower_count (common.MAYBE_UNKNOWN[int]): フォロワーの数
+        manager_count (common.MAYBE_UNKNOWN[int]): マネージャーの数
+        project_count (common.MAYBE_UNKNOWN[int]): プロジェクトの数(<=100)
+    """
     def __repr__(self) -> str:
         return f"<Studio id:{self.id} session:{self.session}>"
 

scapi/utils/common.py

@@ -7,7 +7,7 @@
 
 from . import error,client,config
 
-__version__ = "3.0.0a"
+__version__ = "3.0.0.dev1"
 
 _KT = TypeVar("_KT")
 _VT = TypeVar("_VT")