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 documentation 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.13.tar.gz (120.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yatta_py-1.3.13-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yatta_py-1.3.13.tar.gz
Algorithm Hash digest
SHA256 14dd4b45159fd84e99a05db4fc38be4e923027b7366668d97eba8a33ed4209c0
MD5 78b7ae8f462c9a9f6195ef530c64e76c
BLAKE2b-256 5b6b9cf170b7219325caabd5d26b7b6def348a15c0ad78a954e01ff9641bde58

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yatta_py-1.3.13-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.10

File hashes

Hashes for yatta_py-1.3.13-py3-none-any.whl
Algorithm Hash digest
SHA256 7fb89db3f8489f8b03e44c2ea60a525f36d34c1d759960fb8d2fe67be6423d00
MD5 0d768823fa70dbab71901a2c637ec4ed
BLAKE2b-256 f95439d4a224eb5c1cdff679ed4f46e53fbe1a828b78a9f98e7ac1ea2fbf8a60

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