Skip to main content

Async API wrapper for Project Yatta (sr.yatta.moe) written in Python

Project description

yatta-py

Introduction

yatta-py is an async API wrapper for Project Yatta written in Python.
Project Yatta is a beautiful website that displays Honkai: Star Rail game data.
Developing something for Hoyoverse games? You might be interested in other API wrappers written by me.

Note: I am not the developer of Project Yatta.

Features

  • Fully typed.
  • Fully asynchronous by using aiofiles, aiohttp, and asyncio, suitable for Discord bots.
  • Provides direct icon URLs.
  • Supports Python 3.11+.
  • Supports all game languages.
  • Supports persistent caching using SQLite.
  • Supports Pydantic V2, this also means full autocomplete support.

Installation

# poetry
poetry add yatta-py

# pip
pip install yatta-py

Quick Example

import yatta
import asyncio

async def main() -> None:
    async with yatta.YattaAPI(yatta.Language.CHT) as client:
        await client.fetch_characters()

asyncio.run(main())

Getting Started

Read the wiki to learn more about on how to use this wrapper.

Questions, Issues, Feedback, Contributions

Whether you want to make any bug reports, feature requests, or contribute to the wrapper, simply open an issue or pull request in this repository.
If GitHub is not your type, you can find me on Discord, my username is @seria_ati.

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

yatta_py-1.3.10.tar.gz (85.7 kB view details)

Uploaded Source

Built Distribution

yatta_py-1.3.10-py3-none-any.whl (39.2 kB view details)

Uploaded Python 3

File details

Details for the file yatta_py-1.3.10.tar.gz.

File metadata

  • Download URL: yatta_py-1.3.10.tar.gz
  • Upload date:
  • Size: 85.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.18

File hashes

Hashes for yatta_py-1.3.10.tar.gz
Algorithm Hash digest
SHA256 5c52c9c25624b2fc5b4ca930d2aa22dfaef84611e7528ec6d05109a1bad35f58
MD5 6a899ce1e146fe8eb1a49d0fff35fc34
BLAKE2b-256 eba13a95ae93436dc52fb723e613822112a436d719a8434a3aad4e53e5daa6ec

See more details on using hashes here.

File details

Details for the file yatta_py-1.3.10-py3-none-any.whl.

File metadata

File hashes

Hashes for yatta_py-1.3.10-py3-none-any.whl
Algorithm Hash digest
SHA256 01dd9d88b06ae221cf909eb8d0d31efe61b7d7a578cd4a9012930249d0cb162a
MD5 664daf20c54395dc2d856b71d5b00525
BLAKE2b-256 bfd34ffb21b867640b78ccf6f15d9c6fc1a3af3d893d6527c0da053395f1428c

See more details on using hashes here.

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