Skip to main content

No project description provided

Project description

ValLib

PyPI - Version GitHub deployments GitHub

A Python authentication module for the RiotGames API, and basic endpoint provider for Valorant.

Features

  • Full auth flow
  • Request helpers
  • Basic endpoints for Valorant
  • Captcha "bypass" without using external services
  • Ability to use external Captcha solvers

Installation

The preferred method of installation is through pip but if you know better use the package manager that you want.

pip install ValLib

Reference

Basic structure

ValLib contains this basic building blocks:

  • User a dataclass containing username and password
  • Auth a dataclass containing ever auth param
  • AuthException a exception class for only when the auth goes wrong because of Riot

And the following methods:

  • authenticate to auth with username+password
  • cookie_token to auth with cookies instead of username+password
  • make_headers to convert Auth into headers for making requests

Usage

Without API helper

import ValLib
import requests

user = ValLib.User("Test", "TestPassword")
auth = ValLib.authenticate(user)
headers = ValLib.make_headers(auth)
data = requests.get("https://auth.riotgames.com/userinfo", headers=headers)
print(data.json())

With API helper

import ValLib

user = ValLib.User("Test", "TestPassword")
auth = ValLib.authenticate(user)
data = ValLib.get("https://auth.riotgames.com/userinfo", auth)
print(data.json())

Regions and Shards

Getting the region and the shard is often one of the most complicated of managing the API. So for that we have the get_region and get_shard methods inside ValLib.api and the ExtraAuth dataclass inside ValLib.structs.

import ValLib
from ValLib.api import get_region, get_shard
from ValLib.structs import ExtraAuth

user = ValLib.User("Test", "TestPassword")
auth = ValLib.authenticate(user)
region = get_region(auth)
shard = get_shard(region)
extra = ExtraAuth(user.username, region, auth)

With this new instance of ExtraAuth we can use the custom API methods that require it of ValLib.api.

Custom methods

Inside ValLib.api there are this customs methods:

  • get_preference to fetch the in-game settings for Valorant
  • set_preference to set the in-game settings for Valorant
  • get_load_out to get the loadout (cosmetics + incognito) for Valorant
  • set_load_out to set the loadout (cosmetics + incognito) for Valorant
  • get_session to grab information about the current Valorant session

Custom Captcha provider

If you need to make automatic auth or just need another way of dealing with captcha you can make your own CaptchaSolver class. Here is an example how to do so:

import ValLib
import requests
from ValLib.captcha import CaptchaSolver, set_solver

class DumbCaptcha(CaptchaSolver):
    def token(self, rqdata, site_key):
        r = requests.get(
            "https://myapi.com",
            json={"rqdata": rqdata, "siteKey": site_key}
        )
        return r.text()

set_solver(DumbCaptcha())
user = ValLib.User("MyUser", "MyPass")
auth = ValLib.authenticate(user) # Will use api for captcha solving

DISCLAIMER: most captcha solving APIs exploit people to solve captchas so I'd recommend against using them but it's at your own risk.

Custom MFA Code

When login into a MFA guarded account, the library will use a standard input for getting the MFA code, but you can use your own, here is an example:

import ValLib
from ValLib.mfa import MfaInput, set_mfa

class MyMfa(MfaInput):
    def mfa(self) -> str:
        return magical_gui_input()

set_mfa(MyMfa())
user = ValLib.User("MyUser", "MyPass")
auth = ValLib.authenticate(user) # Will use your func for MFA input

Roadmap

  • Async
  • More endpoints
  • Better documentation
  • Better exports

Running Tests

Tests need to be run in a development environment with GUI, a navigator, pytest and filling this environment variables.

USERNAME="TestUser"
PASSWORD="TestPassword"

And then running pytest.

Acknowledgements

  • Thanks to Valorant-API and their mantainers
  • Thanks to Hawolt for discovering the Captcha solver
  • Thanks to Techdoodle for his API docs
  • Thanks to the Valorant App Developers discord

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vallib-1.5.0.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

ValLib-1.5.0-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file vallib-1.5.0.tar.gz.

File metadata

  • Download URL: vallib-1.5.0.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for vallib-1.5.0.tar.gz
Algorithm Hash digest
SHA256 73ac65740bf0e765cfcf55e5cf2d852d603388fb4ac692b3bd5d64286fb29c8b
MD5 0626e307e61779b53f267d7a0460648b
BLAKE2b-256 523cac33e42d91982b5416ba9494198e58182e0e1e837bb48ba495891750a414

See more details on using hashes here.

File details

Details for the file ValLib-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: ValLib-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 33.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for ValLib-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a891e48d35bf141f20cbd02c93d4c2b5e9e2fc901e9139a566e435131822b934
MD5 9f68ce9a5b806b043d91d90082b11122
BLAKE2b-256 0664dde2389d6cddd840b54cb38c55690861c715fed7de1a53218b81157bc0ac

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page