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

Uploaded Source

Built Distribution

ambr_py-1.7.13-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.7.13.tar.gz
Algorithm Hash digest
SHA256 fef08b76a936fc3076ee83cb9107b19083aa182c863369372e00e3c7dee73195
MD5 2288e975936eaf38d68fc7b80ba105c7
BLAKE2b-256 9dc913024b795e832241d06ad0671bfd337db689299e0a2b9b904bd8aad998d2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.7.13-py3-none-any.whl
Algorithm Hash digest
SHA256 ba4e6df77b350207c9cace3b347bbdd9e522f4f7485701c6da85519b10083746
MD5 404ceb29fe5f95679e0471d0e1ac7fd3
BLAKE2b-256 805f03109dd51722891eae6584d5db83f68e6899229e00245f4d345e0f36dc87

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