Metadata-Version: 2.1
Name: valorant
Version: 0.3.1
Summary: An unofficial synchronous client package for interacting with Riot Games' Valorant API endpoints.
Home-page: https://github.com/frissyn/valorant.py
Author: frissyn
Author-email: author@example.com
License: UNKNOWN
Description: # valorant.py
        
        [![GitHub Actions](https://camo.githubusercontent.com/0fc9226929794d4d4dfb9ac05a1786942f8e4b4300207224277ac49e22e9fdb6/68747470733a2f2f7472617669732d63692e636f6d2f7073662f626c61636b2e7376673f6272616e63683d6d6173746572)](https://github.com/frissyn/valorant.py/actions)
        [![valorant on PyPI](https://img.shields.io/pypi/v/valorant.svg)](https://pypi.python.org/pypi/valorant)
        [![Downloads](https://pepy.tech/badge/valorant/month)](https://pepy.tech/project/valorant)
        [![License](https://img.shields.io/pypi/l/valorant.svg)](https://pypi.python.org/pypi/valorant)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![Contribute](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/frissyn/valorant.py/issues)
        
        `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 `429`s, valorant.py is the best Valorant API wrapper out there!
        
        **Update Notice:**
        
        Riot recently released a new endpoint along Episode 2: Leaderboards! Leaderboards in `valorant.py` support pagination and attribute finding. Take a look at the following snippet:
        
        ```python
        import valorant
        
        KEY = "RGAPI-Key-Goes-Here"
        client = valorant.Client(kEY)
        
        page1 = client.get_leaderboard(size=25, page=0)
        page2 = client.get_leaderboard(size=25, page=1)
        
        print(page1.players.find(3, "leaderboardRank"))
        print(page2.players.find("haley", "gameName"))
        ```
        
        # Overview
        
        ### Installation
        
        |Manager          |Command                           |
        |:----------------|:---------------------------------|
        |**pip**          |`pip install valorant`            |
        |**poetry**       |`python -m poetry add valorant`   |
        |**easy_install** |`easy_install valorant`           |
        
        
        ### Usage
        
        Quickstart Guide:
        ```python
        import valorant
        
        KEY = "RGAPI-Key-Goes-Here"
        client = valorant.Client(KEY, locale=None)
        
        maps = client.get_maps()
        agents = client.get_characters()
        
        print(agents.get("Viper"))
        print(maps.get("Ascent"))
        ```
        
        ### Documentation
        
        [**valorant.py Documentation**](https://github.com/frissyn/valorant.py/tree/master/docs)
        
        ### Contributing
        
        Bug reports, additional endopint coverage, and other fun stuff is always welcome in [issues](https://github.com/frissyn/valorant.py/issues)!
        
        1. Clone the repository with `git`:
        
           - `git clone https://github.com/frissyn/valorant.py.git`
           - `cd valorant`
        
        2. Make your changes
        3. Create a pull request describing what you changed.
        4. Squash your commits with a reference to your pull request.
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
