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

Uploaded Source

Built Distribution

ambr_py-1.7.7-py3-none-any.whl (36.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.7.7.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Windows/10

File hashes

Hashes for ambr_py-1.7.7.tar.gz
Algorithm Hash digest
SHA256 238215cb366a81ae4edff5c3e9b2785451a59a749801d568d335312d623e1d0e
MD5 9e8a7a6e7b1464755f23f778c23b4ad7
BLAKE2b-256 e6ef181bec24dfd10ce5abb32bac7228f8e0627fbc311369886bbc1f1cf5e327

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.7.7-py3-none-any.whl
  • Upload date:
  • Size: 36.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Windows/10

File hashes

Hashes for ambr_py-1.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 69c2d22daf0dc930c0b0a8045feb9f98d6b4fdccd74c32377173faa54a92476c
MD5 fdedfb2f6fea00e39c0db439bbd69142
BLAKE2b-256 cc2eff59d7877c9d263b272dc78c10701b9fc952e810238ee838c9319669fb73

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