.. _installation:

Installation
============

1. Install the package

Clone the repo and install locally:
::

    git clone https://github.com/jvb2358/boatwright.git
    pip install ./boatwright

2. Configure 3rd party API keys (Optional but recommended):

::

    boatwright init

This creates a ``config.json`` file in your platform's standard user config directory:

- **macOS**: ``~/Library/Application Support/boatwright/config.json``
- **Linux**: ``~/.config/boatwright/config.json``
- **Windows**: ``%APPDATA%\boatwright\config.json``

Open the file and fill in your API credentials:

::

    {
        "DATA_DIR": "~/HistoricalData",
        "DEFAULT_DATA_SOURCE": "ALPACA",
        "COINBASE": {
            "key": "users_api_key_here",
            "secret": "users_secret_api_key_here"
        },
        "ALPACA": {
            "key": "users_api_key_here",
            "secret": "users_secret_api_key_here"
        },
        "ALPACA_PAPER": {
            "key": "users_api_key_here",
            "secret": "users_secret_api_key_here"
        },
        "MASSIVE": {
            "key": "users_api_key_here",
            "secret": None
        },
    }

.. note::

   The config directory can be overridden by setting the ``BOATWRIGHT_CONFIG_DIR``
   environment variable to any directory of your choice.

Dependencies:
~~~~~~~~~~~~~

- numpy
- pandas
- platformdirs
- tqdm
- multiprocess
- websockets
- requests
- matplotlib
- mplcursors

Optional dependencies for data collection and live trading:

- alpaca-py
- coinbase-advanced-py
- massive