Skip to content
This repository was archived by the owner on Oct 7, 2021. It is now read-only.

jaebradley/yo_client

Repository files navigation

Yo RPC API Client

Build Status codecov PyPI version

Introduction

This is a Python client for the Yo RPC API.

Installation

pip install YoClient

Usage

Instantiation

Instantiate a client by passing an API Key in the constructor

from yo_client import YoClient

client = YoClient("some_api_key")

Send a Yo

Send a Yo to a user with optional text and an optional link or coordinate.

Currently, the Yo API allows either a link or coordinate to be sent with a Yo, but not both.

from yo_client import YoClient

client = YoClient("some_api_key")
response = client.send_yo(username="some_username", text="some_text", link="some_link")

Send a Yo to All Subscribers

Send a Yo to all subscribers - the only value to pass this method is a link.

from yo_client import YoClient

client = YoClient("some_api_key")
response = client.send_yo_to_all_subscribers(link="some_link")

Create a Yo Account

from yo_client import YoClient

client = YoClient("some_api_key")
response = client.create_account(username="some_username")

Check if a Username Exists

from yo_client import YoClient

client = YoClient("some_api_key")
response = client.username_exists(username="some_username")

Get Subscribers Count

from yo_client import YoClient

client = YoClient("some_api_key")
response = client.get_subscribers_count()

About

A Client for the Yo RPC API

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages