yaylib 2.2.1__tar.gz → 2.3.0__tar.gz

yaylib-2.3.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: yaylib
+Version: 2.3.0
+Summary: Yay! API client SDK
+License: MIT
+Keywords: Yay!,yay-api,Yay! API
+Author: ekkx
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Dist: aiohttp (>=3.8.4)
+Requires-Dist: aiohttp-retry (>=2.8.3)
+Requires-Dist: pillow (>=9.0.0)
+Requires-Dist: pydantic (>=2)
+Requires-Dist: python-dateutil (>=2.8.2)
+Requires-Dist: typing-extensions (>=4.7.1)
+Requires-Dist: urllib3 (>=1.25.3,<3.0.0)
+Project-URL: Homepage, https://github.com/ekkx/yaylib
+Project-URL: Repository, https://github.com/ekkx/yaylib
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<img src="https://github.com/ekkx/yaylib/assets/77382767/45c45b21-d812-4cad-8f27-315ffef53201" alt="yaylib" height="160px">
+
+### yaylib
+
+**好きでつながるバーチャルワールド - Yay! の API ライブラリ**
+
+<a href="https://github.com/ekkx/yaylib/tree/master/packages/python"><img src="https://img.shields.io/badge/Python-3776AB?style=flat-square&logo=python&logoColor=white" alt="Python"></a>
+
+<sub>あらゆる操作の自動化や、ボットの開発が可能です。</sub>
+
+<a href="https://discord.gg/MEuBfNtqRN">Discord に参加</a>
+
+</div>
+
+Yay! の API を Python から扱うための非公式 SDK です。
+
+### インストール
+
+```sh
+pip install yaylib
+```
+
+対応バージョン: Python 3.10 / 3.11 / 3.12 / 3.13
+
+### クイックスタート
+
+```python
+import asyncio
+import yaylib
+
+
+async def main():
+    # `async with` で接続が自動的にクローズされます
+    async with yaylib.Client() as client:
+        # ログイン（セッションは透過的にキャッシュされます）
+        await client.login_with_email(email="...", password="...")
+
+        # タイムラインを取得
+        timeline = await client.get_timeline(
+            noreply_mode=yaylib.NoreplyMode.EMPTY, number=20
+        )
+        for post in timeline.posts:
+            print(post.id, post.text)
+
+        # 投稿する
+        await client.create_post(
+            x_jwt=client.generate_x_jwt(),
+            post_type="text",
+            text="hello from yaylib",
+        )
+
+
+asyncio.run(main())
+```
+
+すべてのオペレーションは `client.<operation>` として直接呼び出せます。
+
+### イベントストリーム
+
+```python
+async with client.open_event_stream() as stream:
+    sub = stream.subscribe(yaylib.chat_room_channel())
+
+    # 新着メッセージを受信
+    @sub.on_new_message
+    async def _(event):
+        print("new message:", event)
+
+    await sub.wait_closed()
+```
+
+### サンプル
+
+実行できるサンプルを [`examples/`](https://github.com/ekkx/yaylib/tree/master/examples/python) に用意しています（全言語共通）。
+
+- 認証 + タイムライン取得
+- テキスト投稿
+- イベントストリームの簡単なボット
+- セッション永続化とエラー処理
+
+```bash
+YAY_EMAIL=... YAY_PASSWORD=... python examples/python/timeline.py
+```
+
+### ⚖️ ライセンス
+
+<p align="center">
+  <a href="https://github.com/ekkx">
+    <img src="https://github.com/ekkx/yaylib/assets/77382767/5d6aef18-5d98-4c9b-9f54-791308b393af" width="256" height="256">
+  </a>
+</p>
+
+<p align="center">
+  <strong>MIT © <a href="https://github.com/ekkx">ekkx</a></strong>
+</p>
+

yaylib-2.3.0/pyproject.toml

@@ -0,0 +1,102 @@
+[tool.poetry]
+name = "yaylib"
+version = "2.3.0"
+description = "Yay! API client SDK"
+authors = ["ekkx"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/ekkx/yaylib"
+repository = "https://github.com/ekkx/yaylib"
+keywords = ["Yay!", "yay-api", "Yay! API"]
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+include = ["yaylib/py.typed"]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+
+urllib3 = ">=1.25.3,<3.0.0"
+python-dateutil = ">= 2.8.2"
+aiohttp = ">= 3.8.4"
+aiohttp-retry = ">= 2.8.3"
+pydantic = ">= 2"
+typing-extensions = ">= 4.7.1"
+pillow = ">= 9.0.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">= 7.2.1"
+pytest-asyncio = ">= 0.21"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "yaylib",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "yaylib.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true