Skip to main content

Yay! API client SDK

Project description

yaylib

yaylib

好きでつながるバーチャルワールド - Yay! の API ライブラリ

Python

あらゆる操作の自動化や、ボットの開発が可能です。

Discord に参加

Yay! の API を Python から扱うための非公式 SDK です。

インストール

pip install yaylib

対応バージョン: Python 3.10 / 3.11 / 3.12 / 3.13

クイックスタート

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> として直接呼び出せます。

イベントストリーム

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/ に用意しています(全言語共通)。

  • 認証 + タイムライン取得
  • テキスト投稿
  • イベントストリームの簡単なボット
  • セッション永続化とエラー処理
YAY_EMAIL=... YAY_PASSWORD=... python examples/python/timeline.py

⚖️ ライセンス

MIT © ekkx

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yaylib-2.0.1.tar.gz (268.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yaylib-2.0.1-py3-none-any.whl (863.1 kB view details)

Uploaded Python 3

File details

Details for the file yaylib-2.0.1.tar.gz.

File metadata

  • Download URL: yaylib-2.0.1.tar.gz
  • Upload date:
  • Size: 268.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yaylib-2.0.1.tar.gz
Algorithm Hash digest
SHA256 ad6606a48c940ee43954334e6772058e6c3773de1e7f8f0187794309406275c0
MD5 0993900a472ae843b2bfec7f00890409
BLAKE2b-256 cc713327b45f25d9039655eea37e548c3740648651fa365a621ceb07829cc71b

See more details on using hashes here.

File details

Details for the file yaylib-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: yaylib-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 863.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yaylib-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 32d7b0e9bf09eb6e3d35e12ce7d7c44b2d38896a52c58c8f9ed5d15b70da56c3
MD5 b4156e7c6e779826be1432634b498f3b
BLAKE2b-256 42e916d536146f676506f39412e2513556a1fcc4b25295af4030e512698317eb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page