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.10.tar.gz (148.4 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.10-py3-none-any.whl (61.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambr_py-1.8.10.tar.gz
  • Upload date:
  • Size: 148.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ambr_py-1.8.10.tar.gz
Algorithm Hash digest
SHA256 d6151b255ed57a8336297a7d962bbc288932cc3094fa11d02838e1202aceb752
MD5 92840f6465f8ae55c9516a0675965de7
BLAKE2b-256 049a9a95069b3d8908876e604afa5752689463fda7cb00508dff5b39b28fd2aa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambr_py-1.8.10-py3-none-any.whl
  • Upload date:
  • Size: 61.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ambr_py-1.8.10-py3-none-any.whl
Algorithm Hash digest
SHA256 57d9664874288afe40bd1e180b423be1eb5062c90808042e143de8bf9c176172
MD5 7d4431ba70ca712067332dbf24b60ada
BLAKE2b-256 f3e8c7f8a84e77b5d90ad817e7bc0f745e10f0939e9e8890a938b2e222d3e0f0

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