Skip to main content

An API wrapper for Genshin Impact.

Project description

genshin.py

Modern API wrapper for Genshin Impact built on asyncio and pydantic.


Documentation: https://thesadru.github.io/genshin.py

Source Code: https://github.com/thesadru/genshin.py


The primary focus of genshin.py is convenience. The entire project is fully type-hinted and abstracts a large amount of the api to be easier to use.

Key features:

  • All data is in the form of Pydantic Models which means full autocompletion and linter support.
  • Requests are significantly faster thanks to proper usage of asyncio.
  • Chinese and Engrish names returned by the API are renamed to simpler English fields.
  • Supports the majority of the popular endpoints.
  • Cleanly integrates with frameworks like FastAPI out of the box.

Note: This library is a successor to genshinstats - an unofficial wrapper for the Genshin Impact api.

Requirements

  • Python 3.8+
  • aiohttp
  • Pydantic
pip install genshin

Example

A very simple example of how genshin.py would be used:

import asyncio
import genshin

async def main():
    cookies = {"ltuid": 119480035, "ltoken": "cnF7TiZqHAAvYqgCBoSPx5EjwezOh1ZHoqSHf7dT"}
    client = genshin.Client(cookies)

    data = await client.get_genshin_user(710785423)
    print(f"User has a total of {data.stats.characters} characters")

asyncio.run(main())

Contributing

Any kind of contribution is welcome. Please read CONTRIBUTING.md to see what you need to do to make a contribution.

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

genshin-1.1.0.tar.gz (62.6 kB view details)

Uploaded Source

Built Distribution

genshin-1.1.0-py3-none-any.whl (85.5 kB view details)

Uploaded Python 3

File details

Details for the file genshin-1.1.0.tar.gz.

File metadata

  • Download URL: genshin-1.1.0.tar.gz
  • Upload date:
  • Size: 62.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for genshin-1.1.0.tar.gz
Algorithm Hash digest
SHA256 aa0e2e36bb595de42e2a7d752474f4c1892b44969316c8a6f95b9c00f8cb4236
MD5 000decaf433ff5efa1eff65bf8af06af
BLAKE2b-256 1344dee57799262376988cb8e50c4121ded8d2044aecd7db72659e0aae9c1ff7

See more details on using hashes here.

File details

Details for the file genshin-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: genshin-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 85.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for genshin-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d92d1a850fe4eee75406c83ece09e3b8eead870e73cdf5225b32fcc74dc4859a
MD5 60589a1aa6de949366e77e19306ed5f6
BLAKE2b-256 0f8c6f598de4ca143605d4b44ff0d5cfa26c018960196413cc1cc5df1f66f3d2

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