Skip to main content

API wrapper for ambr.top written in Python

Project description

ambr-py

Quick links

Developing something for Hoyoverse games? Here's a collection of Python async API wrappers for Hoyoverse games made by me:

  • enka.py is an Enka Network API wrapper for fetching in-game showcase.
  • yatta.py is a Project Yatta API wrapper for fetching Honkai Star Rail game data.
  • ambr.py is a Project Ambr API wrapper for fetching Genshin Impact game data.
  • hakushin.py is a Hakushin API wrapper for fetching Genshin Impact and Honkai Star Rail beta game data.

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.

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, Contributions

For questions, you can contact me on Discord or open an issue.
To report issues with this wrapper, open an issue.
To contribute, fork this repo and submit a pull request.

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.7.8.tar.gz (28.6 kB view details)

Uploaded Source

Built Distribution

ambr_py-1.7.8-py3-none-any.whl (36.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.7.8.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/6.5.0-1021-azure

File hashes

Hashes for ambr_py-1.7.8.tar.gz
Algorithm Hash digest
SHA256 c5ac3b14cff9a468d2fdb8d44c5ebdaba7718b904423ccd9a3e12b0d15d88436
MD5 1c4fae74aa89ede7036a737e3ce77039
BLAKE2b-256 3e6e0203d0f9a92448a3f022341e865dbba4fe13c4865c67861013cdc60f661d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.7.8-py3-none-any.whl
  • Upload date:
  • Size: 36.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/6.5.0-1021-azure

File hashes

Hashes for ambr_py-1.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ab40fdc39544e4ed9e17598e847a9eac5d8c9f27b31343c1cd31d27c9d6e2e08
MD5 900a19ca236b3dba710e36294259b4fd
BLAKE2b-256 a6b31ba63efb0b61716da83f5d78fe35e1acffb5cd9f7fdd0da43d31bbc7b2a5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page