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

This version

2.2.1

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.2.1.tar.gz (272.9 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.2.1-py3-none-any.whl (869.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yaylib-2.2.1.tar.gz
Algorithm Hash digest
SHA256 761f5bf6d7f473d728444af3a50bcdff9427cdbeda0fdc9c9c89560eddca2bd8
MD5 6ac7216ed04d2d01bb128cc208a58519
BLAKE2b-256 e5824c59fd2fa20454db0c750d251e5c90698bd83807af8a4a3fe7e403d5ea59

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yaylib-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 869.2 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1cf3f5af4304e6aa59a71963818da6985919ac02c5d84ae02afe6dd6b002ecca
MD5 e826a7c6fd6d2219c5a5998c104b4f67
BLAKE2b-256 dbe4ca145d399690219a067cf098982f11b7b183100dd564b252eca730e5367b

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