.. birdeye-py documentation master file, created by
   sphinx-quickstart on Sat Nov 23 19:11:51 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

BirdEye Python: The Python Wrapper for BirdEye API
==================================================

BirdEye Python documentation is organized into the following sections:

- :ref:`getting_started`
- :ref:`code_overview`
- :ref:`package_info`

Documentation Conventions
-------------------------

Unless otherwise mentioned, all examples in this document assume the use of a **script**
application.

.. _getting_started:

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

    getting_started/quick_start
    getting_started/installation

.. _code_overview:

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

    code_overview/client

.. _package_info:

.. toctree::
    :maxdepth: 1
    :caption: Package Info

    package_info/contributing
    package_info/references