Skip to main content

Complete Python interface for the Valorant API. Works right out of the box!

Project description

valorant.py

GitHub Actions valorant on PyPI Downloads License Code style: black Contribute Discord Chat

valorant.py is an unofficial API wrapper for Riot Games' Valorant API endpoints. It's modern, easy to use, feature-rich, and intuitive!

Features

Simple: High-level abstraction of API interactions; easy to use and easy to customize.

Lightweight: Doesn't rely on any external dependencies, minimal package size.

Extensive: Covers all Valorant related endpoints from the Riot Games API. Also includes Account coverage.

Fast: HTTP requests and object instancing optimized to use minimal resources and complete tasks quickly!

Intuitive: Complete auto-completion, docstrings, and type-hinting for all library objects and variables.

Installation

valorant.py requires Python 3.8 or higher.

Manager Command
PIP pip install valorant
Poetry poetry add valorant
PIPEnv pipenv install valorant

Usage

Take a look at the examples/ folder for more usage snippets!

Quickstart:

import valorant

KEY = "RGAPI-Key-Here"
client = valorant.Client(KEY)

agents = client.get_characters()

print(agents.get("Viper"))

Local Client:

import valorant

client = valorant.LocalClient()

print(client.get_session())

NOTE: The Local Client interacts with the Client API that Valorant uses while the game is running on your system. This means access to current player, friend requests, shop, etc. The Local Client is currently unstable. valorant.py is not liable for any punishment you may recieve should you use its tools to break Valorant ToS. (i.e Auto-Agent Selection)

Documentation

The public API documentation for valorant.py is hosted on ReadTheDocs.io.

Use bash bin/docs to start the documentation server locally. This uses Ruby's WEBrick gem.

Help and Questions

Have a bug or issue? Need help with the API? Open an issue or hop in the #valorant-py channel of my Community Discord Server.

Contributing

  1. Fork the repository: Fork
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -a -m 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request! 🎉

You can also re-create these steps with GitHub Desktop, Visual Studio Code, or whatever git version control UI you prefer. You don't have to, but I use prefixes for all my commits (i.e ✨: add asyncio run to package namespace). I have a personal style guide that I use, which you can find here.

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

valorant-1.0.2.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

valorant-1.0.2-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file valorant-1.0.2.tar.gz.

File metadata

  • Download URL: valorant-1.0.2.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.6 tqdm/4.62.2 importlib-metadata/4.11.3 keyring/21.8.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for valorant-1.0.2.tar.gz
Algorithm Hash digest
SHA256 453f61e4fcc77a6bec4837021794d8cd31988f185c7c11296c3b9307acd0d11f
MD5 f92d8d323d41f50c6579d987c2b709f3
BLAKE2b-256 1eb4cb9b2d92f7ef9138edcdf2afd6094decce01be4cc43e60bc072e65ece3e0

See more details on using hashes here.

File details

Details for the file valorant-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: valorant-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.6 tqdm/4.62.2 importlib-metadata/4.11.3 keyring/21.8.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for valorant-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0e54dae0ab0a57fa407df9887471f24a1ad7cd4e9072c4151c0ff78ca99f68ba
MD5 6c351d20cfd520644162a3f8f0153a27
BLAKE2b-256 0cfec34ec2f560bf417722a2cadd408d3d50df57648222307aa155fcf7773336

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