Git Product home page Git Product logo

valorant.py's Introduction

valorant.py

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

valorant.py is an unofficial API wrapper for Riot Games' Valorant API endpoints. It's modern, easy to use, feature-rich, and intuitive! Implemented with object oriented designs and explicit reloads to prevent 429s, valorant.py is the best Valorant API wrapper out there!

Bulletin Board

Most recent version: 0.5.1 (๐ŸŽ‰)

Changes:

  • Internal redesign of HTTP requests
  • Updates to error handling for Client and AsyncClient
  • A few more bug fixes (๐Ÿ‘)
  • References: #24, #20, #23, #26

Coming Soon: Endpoint coverage for matches!

Installation

Manager Command
PIP pip install valorant
Poetry python -m poetry add valorant
Easy Install easy_install valorant

Usage

Quickstart:

import valorant

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

agents = client.get_characters()

for agent in agents:
    print(agent.name)

Asynchronous Client:

import valorant

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

async def _main():
    agents = await client.get_characters()

    for agent in agents:
        print(agent.name)

valorant.run(_main())

Local Client:

This is intended for use with the game locally. Eases the use of doing things like getting live match data, chat sessions, friend requests, etc. Doesn't need an access key. The current Local Client is a work-in-progress and is unstable.

import valorant

client = valorant.LocalClient()

print(client.get_session())

Documentation

The public API documentation for valorant.py is hosted here.

If you're making edits to the documentation, you can generate the HTML and start a local server by running bash bin/docs.sh in the repository directory. This requires Ruby 2.5 or higher (Sorry if you have to install Ruby just to edit the docs =P).

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.

Final Note

Thanks for taking the time to check out valorant.py! ๐ŸŽ‰

valorant.py's People

Contributors

frissyn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.