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.7.tar.gz (134.2 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.7-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.7.tar.gz
Algorithm Hash digest
SHA256 c9a28dd85b6bbc9ea011a78037d140b8cce2df080d4978e9f928ae2a5a054196
MD5 6f7e318ee2d084f9722ad14a563cc372
BLAKE2b-256 d517b59d578e6da88670d8615981a14b0c98c67466579ffd120bab264bed8d22

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.7-py3-none-any.whl
Algorithm Hash digest
SHA256 fcba5cdf16e0334e1d5a2c350511fc832dba58ace3bc2e9e8cb25a9d7ebd9f1e
MD5 ee17740677e927c405ad20c1131bc847
BLAKE2b-256 b4a1ed75cbf8fab91181221a00d8317c0a0b33d4e312297bb58144d50c9f3734

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