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

Uploaded Source

Built Distribution

ambr_py-1.7.5-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.7.5.tar.gz
  • Upload date:
  • Size: 27.4 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.5.tar.gz
Algorithm Hash digest
SHA256 e0689155985312a43eb46a3237b9718f0562c693855fb4700a0709919eeae6a4
MD5 f38b2e23b3e03063f66e2bead5c1517c
BLAKE2b-256 d099022aa8bab3b4d666fe371d304feb2155918eaa6d7e315ba7cbc3d80f4264

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.7.5-py3-none-any.whl
  • Upload date:
  • Size: 35.4 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cb6e9a1e0504d595c74aad00550f512f79a908ba54fc16425ed320f303a13671
MD5 4e866a4d0348b584512d51c5494f1d12
BLAKE2b-256 11c40ee25ad0bb41f53e5f9a76f081128553f4c674e19215fabcd72aa8c9f16a

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