Skip to main content

This Python package provides an easy-to-use interface for accessing data from Yay! (https://yay.space/). With this API Client, you can retrieve user profiles, posts, comments, and other content from Yay!, as well as perform common tasks like liking and commenting on posts.

Project description


Logo

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

✨ 投稿を作成する

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")

Writing Text Threads

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

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=373189088)

✨ タイムラインを 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)

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

(トップに戻る)

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

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

MindReader AI 香ばしいボット GIGAZINE

開発者: 毛の可能性


開発者: めんぶれ天然水。


開発者: ぺゅー

:handshake: 共同開発について

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

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

Buy me a coffee

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

Buy Me A Coffee

免責事項

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

ライセンス

MIT © Qvco & Konn

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

(トップに戻る)

Project details


Download files

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

Source Distribution

yaylib-1.0.4.tar.gz (62.5 kB view hashes)

Uploaded Source

Built Distribution

yaylib-1.0.4-py3-none-any.whl (72.8 kB view hashes)

Uploaded Python 3

Supported by

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