Skip to main content

Async API wrapper for Project Amber (gi.yatta.moe) written in Python

Project description

ambr-py

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.
Developing something for Hoyoverse games? You might be interested in other API wrappers written by me.

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, Feedback, Contributions

Whether you want to make any bug reports, feature requests, or contribute to the wrapper, simply open an issue or pull request in this repository.
If GitHub is not your type, you can find me on Discord, my username is @seria_ati.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ambr_py-1.8.2-py3-none-any.whl (51.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.8.2.tar.gz
  • Upload date:
  • Size: 77.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.14

File hashes

Hashes for ambr_py-1.8.2.tar.gz
Algorithm Hash digest
SHA256 1e08d0aecb42a656abdc6468add3f8a661ba776a09748edd8fd480db6de90633
MD5 f7d231ef7766495c32749d68a4f14923
BLAKE2b-256 3720ecf03a05947d48256fba5615dd5c54decf0282a037b0855379fa054c74ac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.8.2-py3-none-any.whl
  • Upload date:
  • Size: 51.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.14

File hashes

Hashes for ambr_py-1.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c471003499ea863bf1cb783710ddb5f2f74ea844c521e4990383d6746da588cf
MD5 2d34cc077a638f4e3c76f875af1a1844
BLAKE2b-256 ae7b008274b35a6fba15b02cba01357357516f0e2be9d7dc7e0e75f8c695df05

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page