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

ambr_py-1.8.9.tar.gz (148.3 kB view details)

Uploaded Source

Built Distribution

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

ambr_py-1.8.9-py3-none-any.whl (61.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.9.tar.gz
Algorithm Hash digest
SHA256 b57274dbd955a7c5a5f0e98bd8277edfcc1458b74a6a0c936702ce6c0ec38c1c
MD5 eb62e732efcda447da47769f0031794e
BLAKE2b-256 e56d78a2521e0ec84f7706aa76afe59973b7d592efb1068ed46a71afb6970690

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.8.9-py3-none-any.whl
  • Upload date:
  • Size: 61.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for ambr_py-1.8.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e943f1e1094910456138e9afc9c54b2a7dcbbbdf32bdbad68d2761b1d3619083
MD5 41fbf5b73de69a998ad2656149124961
BLAKE2b-256 149e61d5a932cb55263fcedd9077e43682f49f87e6830a8d7479a78362939e87

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