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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.0.tar.gz
Algorithm Hash digest
SHA256 40bb713e3a9511aee7ca41e3655564afbc467abd335144dc1c007892c1db726b
MD5 58417eb5c498ca7f7e6143cfa6f81e21
BLAKE2b-256 7a320a0c8b136f5650c58446f865402911d8fdc33c04fde4540cf176df405e73

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99140b6a7291b9163aa94a24de776a5b9dd0d156eedb193fd2b1658236374148
MD5 d84d66791b02a9694bfa85b851a31257
BLAKE2b-256 eb5ca09eb32fa10d2c1027d0ae49e8f921f068c0444aa759d0e8243a9d728819

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