Metadata-Version: 2.1
Name: pyrez
Version: 1.1.0.1
Summary: An open-source wrapper for Hi-Rez Studios API (Paladins, Realm Royale, and Smite), written in Python.
Home-page: https://github.com/luissilva1044894/pyrez
Author: Luis (Lugg) Gustavo
Author-email: the.nonsocial@gmail.com
Maintainer: Luis (Lugg) Gustavo
Maintainer-email: the.nonsocial@gmail.com
License: MIT
Download-URL: https://github.com/luissilva1044894/pyrez/archive/1.1.0.1.tar.gz
Project-URL: Documentation, https://pyrez.readthedocs.io/en/stable/
Project-URL: Discord: Support Server, https://discord.gg/XkydRPS
Project-URL: Bug Tracker, https://github.com/luissilva1044894/pyrez/issues
Project-URL: Say Thanks!, https://saythanks.io/to/luissilva1044894
Project-URL: Source Code, https://github.com/luissilva1044894/pyrez
Keywords: pyrez,hirez,hi-rez,smite,paladins,realmapi,open-source,api,wrapper,library,python,api-wrapper,paladins-api,smitegame,smiteapi,realm-api,realm-royale,python3,python-3,python-3-6
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,<4
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Requires-Dist: colorama (<1) ; os_name=="nt"
Requires-Dist: requests (<3) ; python_version >= "2.7"
Provides-Extra: dev
Requires-Dist: sphinx (<2) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (<1) ; extra == 'dev'
Requires-Dist: sphinxcontrib-asyncio ; extra == 'dev'
Requires-Dist: sphinxcontrib-websupport ; extra == 'dev'
Requires-Dist: pip (>=19.1.1) ; extra == 'dev'
Requires-Dist: pipenv (>=2018.11.26) ; extra == 'dev'
Requires-Dist: setuptools (>=41.0.1) ; extra == 'dev'
Requires-Dist: twine (>=1.13.0) ; extra == 'dev'
Requires-Dist: wheel (>=0.33.4) ; extra == 'dev'
Requires-Dist: requests (<3) ; (python_version >= "2.7") and extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx (<2) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (<1) ; extra == 'docs'
Requires-Dist: sphinxcontrib-asyncio ; extra == 'docs'
Requires-Dist: sphinxcontrib-websupport ; extra == 'docs'
Requires-Dist: requests (<3) ; (python_version >= "2.7") and extra == 'docs'

## Pyrez: Easiest way to connect to Hi-Rez Studios API
[![License](https://img.shields.io/github/license/luissilva1044894/Pyrez.svg?style=plastic&logoWidth=15)](https://opensource.org/licenses/MIT "Pyrez · MIT License")
[![Discord Server](https://img.shields.io/discord/549020573846470659.svg?style=plastic&logo=discord&logoWidth=15)](https://discord.gg/XkydRPS "Support Server · Discord")
[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/luissilva1044894 "Say Thanks!")

**Pyrez** is an [open-source](https://www.opensource.org "See https://www.opensource.org for the Open Source Definition") wrapper for [*Hi-Rez Studios*](https://www.hirezstudios.com "Hi-Rez Studios") API that supports [*Paladins*](https://www.paladins.com "Paladins Game"), [*Realm Royale*](https://www.realmroyale.com "Realm Royale Game") and [*Smite*](https://www.smitegame.com "Smite Game").

### Built with
- [Python](https://www.python.org/) - 2.7, 3.5, 3.6, & 3.7 are supported.
- [Requests](https://pypi.org/project/requests/)

### Documentation
Official Documentation, which shows all available methods and how to use them: [**Click here!**](https://pyrez.readthedocs.io/en/stable/ "Pyrez · Documentation")

### Support
If you need further help, please join the official [*support server*](
https://discord.gg/XkydRPS "Support Server · Discord") on [Discord](https://discordapp.com/ "Discord App").

### Requirements
- [Access](https://pyrez.readthedocs.io/en/stable/getting_started.html#registration "Form access to Hi-Rez Studios API") to Hi-Rez Studios API.

### Usage

```py
import pyrez

devId=1004
authKey='23DF3C7E9BD14D84BF892AD206B6755C'

def main():
    with pyrez.PaladinsAPI(devId, authKey) as paladins:
        print(paladins.getDataUsed())

if __name__ == '__main__':
	main()
```

### Application Example

- [FlaskPyrezAPI](https://github.com/luissilva1044894/FlaskPyrezAPI) - Example of a web application using Flask and Pyrez.

### License
This project is provided under the [MIT License](https://opensource.org/licenses/MIT "Pyrez · MIT License").

All information obtained is provided by Hi-Rez Studios API and is thus their property. According to Section 11a of the [`API Terms of Use`](https://www.hirezstudios.com/wp-content/themes/hi-rez-studios/pdf/api-terms-of-use-agreement.pdf "Hi-Rez Studios API · Terms of Use"), you must attribute any data provided as below.

> Data provided by Hi-Rez. © 2019 Hi-Rez Studios, Inc. All rights reserved.


