.. kalista documentation master file, created by
   sphinx-quickstart on Fri Nov 17 12:01:05 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Kalista's documentation!
===================================

Kalista is a Python API wrapper for the undocumented League of Legends eSports API.
This project aims to make it more accessible to other developers by providing good documentation and ease of use.

You can find
`Unofficial League of Legends eSports API documentation <https://vickz84259.github.io/lolesports-api-docs/>`_ here.

The documentation is divided into several sections:

- :ref:`getting_started` - How to install kalista and the basics of using it.
- :ref:`code_overview` - An overview of the code structure.

Why use Kalista?
-----------------

- First of its kind: kalista is the first Python API wrapper for the League of Legends eSports API.
- Easy to use: kalista is designed to be easy to use and understand.
- Well documented: kalista is well documented
- Open source: kalista is open source and available on GitHub.
- Fast: kalista is fast and efficient.


Future of Kalista
-----------------
Kalista is still under development and several features are still missing.

- Ghost loading
- More documentation
- More examples
- More tests
- Full support of all models
- Rate limiting
- More error handling

.. _getting_started:

.. toctree::
   :maxdepth: 1
   :caption: Getting Started:

   getting_started/installation
   getting_started/quickstart
   
.. _code_overview:

.. toctree::
   :maxdepth: 1
   :caption: Code Overview:

   code_overview/kalista.models
   code_overview/exceptions
   code_overview/rationale

.. toctree::
    :hidden:

    genindex