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

Uploaded Source

Built Distribution

ambr_py-1.7.6-py3-none-any.whl (36.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.7.6.tar.gz
  • Upload date:
  • Size: 28.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.6.tar.gz
Algorithm Hash digest
SHA256 5fc550e4d2c1988e3141607344459a0f6744f7976a027cec72894eb2b4719856
MD5 380feca9521a10134d84b73d8e746cb1
BLAKE2b-256 87e2276b1016fe159dccca17a7315dc900c15821e6e1a979961433f545928919

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.7.6-py3-none-any.whl
  • Upload date:
  • Size: 36.8 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7df78ba4823e367c61ea42e02f7ae600835a376727533cecb6eec661b6824595
MD5 5087633acffdf9b164e80e17c1e94a75
BLAKE2b-256 ba44e73acb4c66585e85027c2cead933947a1a64ced19e3b4af1832a41b21bf5

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