Skip to main content

Async API wrapper for Project Amber (gi.yatta.moe) written in Python

Project description

ambr-py

Introduction

ambr-py is an async API wrapper for Project Ambr written in Python.
Project Ambr is a beautiful website that displays Genshin Impact 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 Ambr.

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 ambr-py

# pip
pip install ambr-py

Quick Example

import ambr
import asyncio

async def main() -> None:
    async with ambr.AmbrAPI(ambr.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

ambr_py-1.7.16.tar.gz (68.1 kB view details)

Uploaded Source

Built Distribution

ambr_py-1.7.16-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

Details for the file ambr_py-1.7.16.tar.gz.

File metadata

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

File hashes

Hashes for ambr_py-1.7.16.tar.gz
Algorithm Hash digest
SHA256 92fedfa7d89ecf2545c2e1ce5658daf23a278d7dc3286837d77cab732e99612d
MD5 e14cd3af99ce1d4728011442bb8eb929
BLAKE2b-256 81b5ffc7afea20736806e9f6390f7bb56b1c157156a7acbd3094722937511d8f

See more details on using hashes here.

File details

Details for the file ambr_py-1.7.16-py3-none-any.whl.

File metadata

File hashes

Hashes for ambr_py-1.7.16-py3-none-any.whl
Algorithm Hash digest
SHA256 631049db71acc9720bd28ce8f8db33bbd8d1d84bb25803cb527b7581e2258c7f
MD5 38c5a2f8f43363c531cc9c47aa38b5bf
BLAKE2b-256 a75c7f21b0decd175bf58897488db7c62154e23de5da4f747e77d2ce5a0e68c9

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