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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.6.tar.gz
Algorithm Hash digest
SHA256 a9a991e38214c9d8214717fd6e97b8221359c5bfca9fe69f184b1b3a52ebe879
MD5 97a98707b2bf46772e2957abb3afeac7
BLAKE2b-256 61d22e6be8133ce80795c60c1f9b0ee55f624bec9481e86c76efa3cc8a8e0a49

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 636548bbf58ef9d050f50fd26b5a6e7a6acc01b8c6b94f79c7cff707723b4365
MD5 f2cbd1e0ace067358bd60981b06ce4ab
BLAKE2b-256 d87d4f2a32aad014d7b6567c8663a9f020f26601d5b034c2b377bde04378908b

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