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.10+.
  • Supports all game languages.
  • Supports both Genshin Impact and Honkai Star Rail.
  • Supports persistent caching using SQLite.
  • Supports Pydantic V2, this also means full autocomplete support.
  • Seamlessly integrates with GenshinData and StarRailData.

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

Uploaded Source

Built Distribution

ambr_py-1.7.4-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.7.4.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.11 Windows/10

File hashes

Hashes for ambr_py-1.7.4.tar.gz
Algorithm Hash digest
SHA256 4866767a949b32ec717faee0d72eea02c2473068b9fd790b7f9259dd41bafc2a
MD5 6df3dc5d19a1704595c6e5490b60d80e
BLAKE2b-256 ca6ccd76ab2f6bd52a6c0fb03621fb0c2fb8c09afd02bcf18dfb213e47907419

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.7.4-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.11 Windows/10

File hashes

Hashes for ambr_py-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 72403db56ad61d5224e38b7e2cae769bccd82d833dd3ece84f1a0b02776e5f07
MD5 94f64a43b0e4bde8b7d1cb91eb9520bb
BLAKE2b-256 bfaac36c84f2b1344681c99f4bc772fe44c90908b5f099aceb159ecaeb23460e

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