Skip to main content

Python async API wrapper for hsr.yatta.top

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.9.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

yatta_py-1.3.9-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yatta_py-1.3.9.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.8.0-1014-azure

File hashes

Hashes for yatta_py-1.3.9.tar.gz
Algorithm Hash digest
SHA256 eaa054ac6c3f73558ddf9e07f3ffbc6d8b106ed791ebbad0e974ab8e14dd66a8
MD5 4f8a455e6b368ab1674ffacc62cb67f8
BLAKE2b-256 2b404dd80e8cc1c368b536cade181f948b6ffa04261f623e4d8f4e1526449519

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yatta_py-1.3.9-py3-none-any.whl
  • Upload date:
  • Size: 26.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.8.0-1014-azure

File hashes

Hashes for yatta_py-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 71cbf1f8513258527974a68dadffe3fbd1181ad2c75f1c48a91557ef9781672a
MD5 5137b3cb5a57af5e4835a16f363fa145
BLAKE2b-256 2bbfc4abb72d68aa490ba513954578a1e06be9f1a741102eaa7e5ab5f03c44c6

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