Metadata-Version: 2.3
Name: genshin
Version: 1.7.20
Summary: API wrapper for HoYoLAB/Miyoushe API built on asyncio and pydantic.
Author: ashleney
Author-email: ashleney <thesadru@gmail.com>
License: MIT License
         
         Copyright (c) 2021 sadru
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Dist: aiohttp==3.*
Requires-Dist: pydantic==2.*
Requires-Dist: tenacity==9.*
Requires-Dist: aiohttp-socks>=0.9.0 ; extra == 'all'
Requires-Dist: aioredis>=2.0.1 ; extra == 'all'
Requires-Dist: aiosqlite>=0.17.0 ; extra == 'all'
Requires-Dist: browser-cookie3>=0.19.1 ; extra == 'all'
Requires-Dist: click>=8.1.7 ; extra == 'all'
Requires-Dist: qrcode[pil]>=7.4.2 ; extra == 'all'
Requires-Dist: rsa>=4.9 ; extra == 'all'
Requires-Dist: qrcode[pil]>=7.4.2 ; extra == 'auth'
Requires-Dist: rsa>=4.9 ; extra == 'auth'
Requires-Dist: click>=8.1.7 ; extra == 'cli'
Requires-Dist: browser-cookie3>=0.19.1 ; extra == 'cookies'
Requires-Dist: aioredis>=2.0.1 ; extra == 'redis'
Requires-Dist: aiohttp-socks>=0.9.0 ; extra == 'socks-proxy'
Requires-Dist: aiosqlite>=0.17.0 ; extra == 'sqlite'
Maintainer: seriaati
Maintainer-email: seriaati <seriaati@gmail.com>
Requires-Python: >=3.9
Project-URL: Documentation, https://seriaati.github.io/genshin.py
Project-URL: Homepage, https://github.com/seriaati/genshin.py
Project-URL: Issues, https://github.com/seriaati/genshin.py/issues
Project-URL: Repository, https://github.com/seriaati/genshin.py.git
Provides-Extra: all
Provides-Extra: auth
Provides-Extra: cli
Provides-Extra: cookies
Provides-Extra: redis
Provides-Extra: socks-proxy
Provides-Extra: sqlite
Description-Content-Type: text/markdown

# genshin.py

[![Downloads](https://pepy.tech/badge/genshin)](https://pepy.tech/project/genshin)
[![PyPI package](https://img.shields.io/pypi/v/genshin)](https://pypi.org/project/genshin/)
[![Last Commit](https://img.shields.io/github/last-commit/seriaati/genshin.py)](https://github.com/seriaati/genshin.py/commits/master)
[![Code Coverage](https://qlty.sh/badges/f11cc069-77cf-4f20-a2f9-2dc3dc5b45cb/test_coverage.svg)](https://qlty.sh/gh/seriaati/projects/genshin.py)
[![Discord](https://img.shields.io/discord/570841314200125460?color=7289DA)](https://discord.gg/sMkSKRPuCR)

Modern API wrapper for HoYoLAB & Miyoushe(米游社) API built on asyncio and pydantic.

## Project Transferred

genshin.py was originally started by [ashleney](https://github.com/ashleney), due to lack of time to maintain, it has been transferred to [seriaati](https://github.com/seriaati).

Downloading the package from <https://github.com/ashleney/genshin.py> will still work because GitHub automatically redirects to the new repository.

## Useful Links

- [Documentation](https://gh.seria.moe/genshin.py)
- [Source Code](https://github.com/seriaati/genshin.py)
- [Discord Server](https://discord.gg/sMkSKRPuCR)

## Introduction

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 English 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](https://github.com/seriaati/genshinstats) - an unofficial wrapper for the Genshin Impact api.

## Requirements

- Python 3.9+
- aiohttp 3.0+
- Pydantic 2.0+
- tenacity 9.0+

## Installation

To install the stable version:

```console
pip install genshin
```

You can also install the latest development version from GitHub:

```console
pip install git+https://github.com/seriaati/genshin.py
```

A new release is made every month.

## Example

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

```py
import asyncio
import genshin

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

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

asyncio.run(main())
```

## Contributing

Any kind of contribution is welcome.
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) to see what you need to do to make a contribution.

## License

Genshin.py has been actively developed since [2021-02-06](https://github.com/seriaati/genshinstats/commit/223a2405ce6e05008eb8389e481e857fe33de771). Please report any potential copyright violations to the owner through [discord](https://discord.gg/sMkSKRPuCR).
