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.8.1.tar.gz (76.7 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.1-py3-none-any.whl (51.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.1.tar.gz
Algorithm Hash digest
SHA256 f72e24c29dacc1fdcef31ae75b89c7e3fd866142dcc10b698bb52145eab7d61d
MD5 d93ab8ff2daf6bd4f762aac28793ed0f
BLAKE2b-256 d754c86fc10f0b5ee4e97e8e196b80a9378fe45889659454e1ad6ed706695708

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 009795c5b82c5d6be0f1258cd43c10217f64634fb192cf60354589530d3a9f7f
MD5 010c9fe627d9c5f297dfc32fe0f01436
BLAKE2b-256 e639ecb140ee084dff35063e65c70a1829b08308a1aaf23ca84cfa336555a3fd

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