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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.5.tar.gz
Algorithm Hash digest
SHA256 6efa174662be36549de257043c41fa716d891ee76a837d8ff2396421392b47f8
MD5 c2f92c785d35fd38c16848c08012818a
BLAKE2b-256 45a82c49c9d74c13da3b81640716f58e78980079d7e75ba4fc12fc8095622771

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d0830f06dd3e8ccda822665be1e25c4e23b864870cb1e6a1204bc5118ff7c664
MD5 fc3a46b5aaf817988141c13bfcc9ea8d
BLAKE2b-256 78ea4b7addca3e3d8555e6362b950cb826aaf07304056ccf0e5f9374591ac423

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