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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.7.10.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-1024-azure

File hashes

Hashes for ambr_py-1.7.10.tar.gz
Algorithm Hash digest
SHA256 359b8bc8aba5cf3ee2db0ffc1c29afb9f52f328460d9b58d3b947ef52cba9770
MD5 64feb956c3c4a0f54bfddd92751af845
BLAKE2b-256 573d4da73ef4c6f63bba551988afe41f466ef4600d7fbc1a2099bd2c0a9eb7cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.7.10-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-1024-azure

File hashes

Hashes for ambr_py-1.7.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a05bcd907a52c1016888e75d7f38fad7bd939ed1b1067721f2e286ccdcc598ac
MD5 791d5a143531ff80737bbdbd2027e760
BLAKE2b-256 9200ff00c9e2d74f7c4ffb3dd2c7ebc21e6b72bcae0addead720cf1bc64e2f54

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