.. Aio-Trader documentation master file, created by
   sphinx-quickstart on Mon Apr 29 12:32:23 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Aio-Trader's documentation!
======================================

**Aio-Trader** is an async library for accessing Indian stockbroker API and real-time market feeds.

Python version: >= 3.8

.. toctree::

   usage
   authorization
   examples
   implementation
   api_reference

Installation
------------

**1. Clone the repo**

.. code:: console

    git clone https://github.com/BennyThadikaran/Aio-Trader.git

    cd aio_trader

**2. Create a virtual env using venv and activate it.**

.. code:: console

    py -m venv .
    source bin/Activate

    # On Windows, run the below to activate venv
    .\Scripts\Activate.ps1

**3. Install aio_trader**

.. code:: console

    pip install .