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

Uploaded Source

Built Distribution

genshin-1.0.1-py3-none-any.whl (84.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for genshin-1.0.1.tar.gz
Algorithm Hash digest
SHA256 7b4892d69ebf5c5562822a71a7d89d3dce56452538675c39a841a5c4eb6b33f7
MD5 e39e62f91124b5f89abd32ac669ac484
BLAKE2b-256 7d6ee16a6a60619627d12a0472b240cec1f3904635ed69be5cd6a03c9dd5549a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 84.6 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f87ab5ddb38b0d1ec8c4433634f1161d53213e4fe1e650ad9026c950a22b3472
MD5 c91bff3715e97e3e8ef085fa8fb8c0fd
BLAKE2b-256 47e2af7445fdf6a514136e1d3adcdd192734e5f06a8f0d33e57757f5bf1fe128

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