Ei kuvausta

JoostSijm c12ea5bb61 Add appdirs 4 vuotta sitten
rival_regions_wrapper c12ea5bb61 Add appdirs 4 vuotta sitten
.gitignore 44fe624811 Remove app, functions, and credential template 5 vuotta sitten
LICENSE baaed2455a Add setup.py and license, moved some files 4 vuotta sitten
Pipfile c12ea5bb61 Add appdirs 4 vuotta sitten
Pipfile.lock c12ea5bb61 Add appdirs 4 vuotta sitten
README.md 3492ac4c3d Improve readme 4 vuotta sitten
setup.py a4f2717f0c Improve setup file 4 vuotta sitten

README.md

Rival-Regions-Wrapper

This library will functions as an API wrapper for interaction with Rival Regions.

Middleware

The API wrapper uses middleware to decide where how to send the request. Middlewares can also be used to write direct requests to Rival Regions.

Current middleware

LocalAuthentication

Use username, password, and login method to log in local instance of the authenticator.

RemoteAuthentication

Connect through a remote API using URL and authentication key.

Examples

Create local authentication middleman after that log in with environ variables and request region page from Rival Regions

import os
from rival_regions_wrapper import LocalAuthentication

middleware = LocalAuthentication(
  os.environ["USERNAME"],
  os.environ["PASSWORD"],
  os.environ["LOGIN_METHOD"]
)

region = middleware.get('listed/upgrades/{}'.format(region_id))

Contact