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 documentation 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.8.tar.gz (134.0 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.8-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.8.tar.gz
Algorithm Hash digest
SHA256 9b94d49cfd9afa05d9a2f507e946480d1b6e8d3e23cf78c8867b2df4b07e617f
MD5 eb4dd03dc739fa45a3327bc64f09e650
BLAKE2b-256 a785a99f20d276e16cb577feeb06b92460838a45cb8581b5b22ec36ba85708dd

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ambr_py-1.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7b5edfda690bf1bb7f2924a563b3939078f60c419ce8d3b13816a59616c792bc
MD5 6dad1536b368271a41644b3c7bd55345
BLAKE2b-256 8ea91b91dcf500a4485a88d36fa77a81e5857e4cdb5ff1c6ed51f17d7f8beeda

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