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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.7.9.tar.gz
Algorithm Hash digest
SHA256 623e1a102ba0ef716667226c336c8c566e0ad9544e75b78c1b515cb3340af2ed
MD5 24be20365508dcdcff59fc5d1a54328a
BLAKE2b-256 6099d14df663dbb2582b61f5dbb150f1bddb031fa95578a4b5673667bff3cd50

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.7.9-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-1022-azure

File hashes

Hashes for ambr_py-1.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2affef697dddd5307ff2b5848986c40f124442f71b4faa9c5eb73989979539e1
MD5 91cee7eee08e4ecbc0106da31bc8c8cf
BLAKE2b-256 c2fe02f6e98bee88d6c9d647a9d1b620391fc45713f1e43ec33b9563b98efaf5

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