valopy
======

An async Python wrapper for the unofficial Valorant API.

.. note::

   This library is in active development and is currently in beta. **Breaking changes will occur** until 
   version 1.0.0 is released. Please pin your dependency to a specific version to avoid unexpected breaking changes.

Features
--------

* Modern Pythonic API using async/await syntax
* Full type hints for IDE autocompletion and type safety
* Automatic JSON serialization and deserialization
* Comprehensive error handling and resilience strategies


.. toctree::
   :caption: User Guide
   :maxdepth: 1

   guide/getting_started
   guide/features
   examples
   changelogs/index

.. toctree::
   :caption: API Reference
   :maxdepth: 1

   endpoints
   api/client
   api/models
   api/enums
   api/exceptions

About ValoPy
------------

ValoPy is a wrapper around the `Unofficial Valorant API <https://github.com/Henrik-3/unofficial-valorant-api>`_, 
which provides access to Valorant's player and game data.

Need Help?
----------

* Visit the `Unofficial Valorant API Discord <https://discord.com/invite/X3GaVkX2YN>`_ for community support
* Search the `issue tracker <https://github.com/Vinc0739/valopy/issues>`_ for your problem
* Ask on `GitHub Discussions <https://github.com/Vinc0739/valopy/discussions>`_ if you have a question
* Check the `API Status page <https://status.henrikdev.xyz>`_ if endpoints are down

Meta
-----

* `GitHub Repository <https://github.com/Vinc0739/valopy>`_
* `PyPI Package <https://pypi.org/project/valopy>`_
* `License <https://github.com/Vinc0739/valopy/blob/main/LICENSE>`_