README.md

FlaskPyrezAPI

Built with:

FlaskPyrezAPI is an endpoint for custom commands (Twitch), that provides data about players, matches and others stats of the game Paladins. It uses Pyrez, my Python wrapper for Hi-Rez Studios API.

Demo

Key Features

• English, Polish, Portuguese and Spanish language support.

Requirements

• Access to Hi-Rez Studios API.

Support

For support using Pyrez, please join the official support server on Discord.

Installation

Locally

1. Clone this repository: git clone https://github.com/luissilva1044894/FlaskPyrezAPI.git
2. cd into it: cd FlaskPyrezAPI
3. Create a virtualenv: virtualenv -p python venv
4. Activate it.
5. Install Python Dependencies: pip install --upgrade pip setuptools wheel | pip install -r requirements.txt
6. Edit .env and replace the PYREZ_AUTH_ID and PYREZ_DEV_ID with the authId and devId that you receive from Hi-Rez Studios.
7. Run: python manage.py db migrate
8. Run server: python main.py runserver
9. Go to your browser and point it towards http://127.0.0.1:5000

Deploy (Heroku)

1. Go to Heroku and create a new app (eg: your-app-name)
2. Install Heroku CLI
3. heroku login
4. git init
5. heroku git:remote -a your-app-name
6. Download this repo and copy all files into your-app-name folder
7. Edit .env and replace the PYREZ_AUTH_ID and PYREZ_DEV_ID with the authId and devId that you receive from Hi-Rez Studios.
8. heroku config:push
9. git add .
10. git commit -m "Going to Heroku"
11. git push heroku master
12. heroku run python manage.py db migrate
13. heroku open and a window will open with your app online

Thanks

• Lukash (Paladins Poland) - Polish translation.

License 📝

This is an open source project provided under the MIT License, which you can view in LICENSE file.

Raw data provided by Hi-Rez Studios API and is thus their property. © 2019 Hi-Rez Studios, Inc. All rights reserved.