yaylib 1.0.6

同世代と趣味の通話コミュニティ - Yay! (イェイ) で、投稿やタイムラインの取得、リツイートやいいねの実行、フォローや投稿の検索など様々な機能を利用可能なAPIクライアントツールです。

yaylib

「yaylib」は同世代でつながるチャットアプリ、Yay!（イェイ）の API ラッパーです。
あらゆる操作の自動化や、ボットの開発が可能です。

ドキュメントはこちらから »

Report Bug · Request Feature · Join the discord

Table of Contents

1. インストール
2. 使用例
3. yaylib で誕生したロボットたち
4. Buy me a coffee
5. 共同開発について
6. 免責事項
7. 利用許諾

Installation

※ Python 3.11 かそれ以上のバージョンが必要です。

「yaylib」をインストールするには、以下のコマンドを実行します:

pip install yaylib

Note 開発バージョンをインストールする場合は、以下の手順を実行します:

git clone https://github.com/qvco/yaylib

cd yaylib

pip install -r requirements.txt

pip install -e .

「yaylib」の始め方については、こちら を確認してください。

Quick Example

yaylib 利用で実現できること

カテゴリ	「yaylib」で自動化できること	応用先
データ収集の効率化	投稿情報取得 ユーザー情報取得 人気のワード取得 フォロー/フォロワー情報取得	SNSデータマーケティング トレンド解析 ニーズ調査
アカウント操作 (投稿関連)	投稿する リツイートする いいねする	Yay! 自動運用 Yay! Bot開発
アカウント操作 (ユーザー関連)	フォローする/フォロー解除する ブロックする/ブロック解除する ミュートする/ミュート解除する DMを送る	Yay! 自動運用 Yay! Bot開発

✨ 投稿を作成する

import yaylib

api = yaylib.Client()
api.login(email="メールアドレス", password="パスワード")

api.create_post("Hello with yaylib!")

✨ 埋め込みリンクの投稿を作成する

import yaylib

api = yaylib.Client()
api.login(email="メールアドレス", password="パスワード")

api.create_post("Hello with yaylib!", shared_url="https://github.com/qvco/yaylib")

✨ 画像と一緒に投稿を作成する

import yaylib

api = yaylib.Client()
api.login(email="メールアドレス", password="パスワード")

filename = api.upload_image(
    image_type="post", # 画像の使い道を指定
    image_path="./path/to/image" # ローカルにある画像のパス
)

api.create_post("Hello with yaylib!", attachment_filename=filename)

✨ 投稿に返信する

import yaylib

api = yaylib.Client()
api.login(email="メールアドレス", password="パスワード")

api.create_post(
    "Hello with yaylib!",
    in_reply_to=返信先の投稿ID,
    mention_ids=[返信先のユーザーID]
)

✨ タイムラインを 100 件取得する

import yaylib

api = yaylib.Client()

timeline = api.get_timeline(number=100)

for post in timeline.posts:
    print(post.user.nickname)  # 投稿者名
    print(post.text)  # 本文
    print(post.likes_count)  # いいね数
    print(post.reposts_count)  # (´∀｀∩)↑age↑の数
    print(post.in_reply_to_post_count)  # 返信の数

✨ タイムラインをキーワードで検索して「いいね」する

import yaylib

api = yaylib.Client()
api.login(email="メールアドレス", password="パスワード")

timeline = api.get_timeline_by_keyword(
    keyword="プログラミング",
    number=15
)

for post in timeline.posts:
    response = api.like(post.id)
    print(post.id, response.data) # 実行結果を出力

✨ タイムラインのユーザーをフォローする

import yaylib

api = yaylib.Client()
api.login(email="メールアドレス", password="パスワード")

timeline = api.get_timeline(number=15)

for post in timeline.posts:
    api.follow_user(post.user.id)

✨ リアルタイムでチャットを取得する

import yaylib

api = yaylib.Client()
api.login(email="メールアドレス", password="パスワード")


class ChatBot(yaylib.ChatRoomEventHandler):

    def on_request(self, total_count: int):
        # チャットリクエストを承認する
        chat_room = api.get_chat_requests(number=1).chat_rooms[0]
        api.accept_chat_requests(chat_room_ids=[chat_room.id])
        self.on_message(chat_room)

    def on_message(self, chat_room):
        # メッセージを出力する
        print(chat_room.last_message.text)


ws_token = api.get_web_socket_token()

bot = ChatBot()
bot.run(ws_token)

より詳しい使用例については、こちら を参照してください。

(トップに戻る)

:crown: yaylib で誕生したロボットたち

「yaylib」を用いて開発したロボットがある場合は、ぜひ教えてください！

MindReader AI	香ばしいボット	GIGAZINE
開発者: 毛の可能性	開発者: めんぶれ天然水。	開発者: ぺゅー

:handshake: 共同開発について

私たちと開発することに興味を持っていただけているなら、ぜひ参加して頂きたいです！

• プルリクエストを送信する
• Discord サーバーに参加する
• [e-mail] にメールを送信する

のいずれかの方法で繋がりましょう。詳しくはこちらから！

Buy me a coffee

このライブラリが気に入っていただけたら、リポジトリにスターをお願いします(⭐)
また、Buy Me a Coffee からご支援いただけますと幸いです。

免責事項

yaylib は、API の公式なサポートやメンテナンスを提供するものではありません。このクライアントを使用する場合、利用者はリスクや責任を自己負担できるものとします。このクライアントによって提供される情報やデータの正確性、信頼性、完全性、適時性について、いかなる保証も行いません。また、このクライアントの使用によって生じた損害や不利益について、一切の責任を負いかねます。利用者は自己の責任において、このクライアントを使用し、API にアクセスするものとします。なお、この免責事項は予告なく変更される場合があります。

ライセンス

MIT © Qvco & Konn

フルライセンスは こちら からご確認いただけます。
このプロジェクトは、 【MIT ライセンス】 の条件の下でライセンスされています。

(トップに戻る)