Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luissilva1044894/pyrez

(ON REWRITE) An easy to use (a)sync wrapper for Hi-Rez Studios API (Paladins, Realm Royale, and Smite), written in Python. 🐍
https://github.com/luissilva1044894/pyrez

aiohttp api-wrapper async async-await asyncio hi-rez hirez hirezapi httpx library open-source paladins paladins-api python python3 realm-royale requests smite smitegame sync

Last synced: 28 days ago
JSON representation

(ON REWRITE) An easy to use (a)sync wrapper for Hi-Rez Studios API (Paladins, Realm Royale, and Smite), written in Python. 🐍

Host: GitHub
URL: https://github.com/luissilva1044894/pyrez
Owner: luissilva1044894
License: mit
Created: 2018-07-01T13:33:21.000Z (over 6 years ago)
Default Branch: 1.1.x
Last Pushed: 2024-03-14T15:40:24.000Z (8 months ago)
Last Synced: 2024-03-14T17:08:14.055Z (8 months ago)
Topics: aiohttp, api-wrapper, async, async-await, asyncio, hi-rez, hirez, hirezapi, httpx, library, open-source, paladins, paladins-api, python, python3, realm-royale, requests, smite, smitegame, sync
Language: Python
Homepage: http://pyrez.rtfd.io
Size: 9.02 MB
Stars: 26
Watchers: 1
Forks: 11
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md

Awesome Lists containing this project

README

        

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

[![License](https://img.shields.io/github/license/luissilva1044894/Pyrez.svg?style=plastic&logoWidth=15)][license]

[![Documentation Status](https://readthedocs.org/projects/pyrez/badge/?version=stable)](https://pyrez.readthedocs.io/en/stable/?badge=stable)

[![PyPi Version](https://img.shields.io/pypi/v/pyrez.svg?style=plastic&logo=pypi&logoWidth=15)][pyrez-pypi]

[![Runtime Version](https://img.shields.io/pypi/pyversions/pyrez.svg?style=plastic&logo=python&logoWidth=15&logoColor=white)][pyrez-pypi]

[![Contributors](https://img.shields.io/github/contributors/luissilva1044894/Pyrez.svg?style=plastic&logo=github&logoWidth=15)](https://github.com/luissilva1044894/Pyrez/graphs/contributors "Contributors")

[![CodeFactor](https://www.codefactor.io/repository/github/luissilva1044894/pyrez/badge/1.1.x)](https://www.codefactor.io/repository/github/luissilva1044894/pyrez/overview/1.1.x "Pyrez · CodeFactor")

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b3bb9e1efed0432ab923c11c2250089c)](https://www.codacy.com/app/luissilva1044894/Pyrez?utm_source=github.com&utm_medium=referral&utm_content=luissilva1044894/Pyrez&utm_campaign=Badge_Grade)

[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/luissilva1044894 "Say Thanks!")

Built with [![Python](https://img.shields.io/badge/Python-3.7.7-blue.svg?style=plastic&logo=python&logoWidth=15&logoColor=white)](https://docs.python.org/3.7/whatsnew/changelog.html#python-3-7-7-final "Python 3.7.7")

[![requests](https://img.shields.io/badge/requests-2.25.1-orange.svg?style=plastic)](https://pypi.org/project/requests/2.25.1/ "requests 2.25.1")

> [**`(A)SYNC` BRANCH** (unstable)](https://github.com/luissilva1044894/Pyrez/tree/master)

**Pyrez** is an easy to use synchronous 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").

### 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...

```markdown hl_lines="7 12"

[![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](https://pyrez.readthedocs.io/en/stable/getting_started.html#registration "Form access to Hi-Rez Studios API") to Hi-Rez Studios API.

 * [Python](https://www.python.org/) - 2.7, 3.5, 3.6, 3.7, 3.8, & 3.9 are supported.

 * [requests](https://2.python-requests.org/en/stable/) - 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!**](https://pyrez.readthedocs.io/en/stable/ "Pyrez · Documentation")

### Installation

The easiest way to install the latest stable version is by using pip/easy_install (or [`pipenv`](https://docs.pipenv.org), of course) to pull it from [`PyPI`](https://pypi.org "Python's package manager ") by running the following command:

```py

pip install pyrez

```

You may also use git to clone the development version from [GitHub][github-repo] and install it manually:

```py

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:

```py

import pyrez

```

### How to use

```py

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](https://github.com/luissilva1044894/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](./.github/CONTRIBUTING.md).

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][github-repo] on GitHub to start making your changes to the **master** branch (or branch off of it).

4. Send a [pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) and bug the maintainer until it gets merged and published. :) Make sure to add yourself to [AUTHORS](./AUTHORS.md).

### 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][github-repo].

This is an open source [![Open Source](https://raw.githubusercontent.com/abhishekbanthia/Public-APIs/master/opensource.png)](https://www.opensource.org "See http://www.opensource.org for the Open Source Definition") project provided under the MIT License, which can be found in the [`LICENSE file`][license]. The programs in the “[examples](./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`][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.

[api-terms-of-use]: https://web2.hirez.com/hirez-studios/legal/api-terms-of-use-agreement.pdf "Hi-Rez Studios API · Terms of Use"

[github-repo]: https://github.com/luissilva1044894/Pyrez "Pyrez · Github repository"

[license]: ./LICENSE "Pyrez · License"

[pyrez-pypi]: https://pypi.org/project/pyrez "Pyrez · PyPI"