Pyrez: Easiest way to connect to Hi-Rez Studios API

Built with

(A)SYNC BRANCH (unstable)

Pyrez is an easy to use synchronous wrapper for Hi-Rez Studios API that supports Paladins, Realm Royale and Smite.

Key Features

• Entire coverage of Hi-Rez Studios API endpoints.
• Easy to use with an object oriented design.

Use this badge in your project's Readme to show you're using Pyrez! The markdown code is below...

[![Pyrez](https://img.shields.io/badge/Using-Pyrez-00bb88.svg?logo=python&logoWidth=20&logoColor=white&style=plastic)](https://github.com/luissilva1044894/pyrez)

Requirements

• Access to Hi-Rez Studios API.
• Python - 2.7, 3.5, 3.6, 3.7, 3.8, & 3.9 are supported.
• requests - 2.0 or greater.

Documentation

Documentation is being hosted on Read the Docs, which shows all available methods and how to use them: Click here!

Installation

The easiest way to install the latest stable version is by using pip/easy_install (or pipenv, of course) to pull it from PyPI by running the following command:

pip install pyrez

You may also use git to clone the development version from GitHub and install it manually:

git clone https://github.com/luissilva1044894/pyrez.git
cd pyrez
python setup.py install

The required dependencies will be installed automatically. Then, to use these functions, you must import the pyrez package:

import pyrez

How to use

import pyrez

fake_dev_id=1004
fake_auth_key='23DF3C7E9BD14D84BF892AD206B6755C'

def main():
    with pyrez.PaladinsAPI(fake_dev_id, fake_auth_key) as paladins:
        print(paladins.getDataUsed())

if __name__ == "__main__":
	main()

Application Example

• FlaskPyrezAPI - Example of a web application using Flask and Pyrez.

How to contribute

1. Become more familiar with the project by reading our Contributor's Guide.
2. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
3. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS.

License

I reserve the right to place future versions of this library under a different license. But if you make any changes or additions to Pyrez itself, those must be released with a compatible license. Basically it means that you can do whatever you want with the code and, where possible, attribute back to the GitHub page.

This is an open source project provided under the MIT License, which can be found in the LICENSE file. The programs in the “examples” subdirectory are in the public domain.

Third-party libraries used by Pyrez are under their own licenses. Please refer to those libraries for details on the license they use.

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, you must attribute any data provided as below.

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