Sibyl Documentation

Introduction

Welcome to the documentation for Sibyl, a Python app for trading using Machine Learning algorithms. This documentation provides an overview of the app's features and how to use them.

Supported APIs

Binance API

Binance Testnet API

Coinbase API

Kraken API

Getting Started

Installation

Clone the repository that contains all the code.

# git clone https://github.com/nMaroulis/sibyl.git

Python Virtual Environment

Install python3.12 in your system

$ brew install python@3.12 # macOS

$ sudo apt install python==3.12  # Linux apt

Create a separate Virtual Environment

$ python3.12 -m venv sibyl
$ source sibyl/bin/activate

Install the pip libraries found in the requirements.txt file.

$ pip install -r requirements.txt

Docker Container

Open the Project directory through the terminal and locate the Dockerfile

$ docker build -t sibyl_image .

This will give you an image on your local machine that you can create a container from. To do so, you'll need to run the following docker run command.

$ docker run -p 8501:8501 -p 8000:8000 sibyl_image

Python Pip

Install the pip libraries found in the requirements.txt file in the home folder.

$ pip install -r requirements.txt

Conda Environment

Install the conda environment found in the conda_env.yml file.

$ conda env create -f conda_env.yml
# conda activate sibyl

Running the App

First navigate to the sibyl folder in your system and run the main.py script which starts the Frontend and the Backend.

$ cd ./sibyl 
# python3.12 main.py

Once the app is running, you can access it by opening the provided URL in your web browser.

Features

Connect APIs

Sibyl provides the functionality to store your API keys in an encrypted local database. These API keys can be for exchanges (i.e. Binance, Coinbase, Kraken), LLM APIs (i.e. Hugging Face, OpenAI API etc.) and more.

Algorithmic Trading

Sibyl provides a range of algorithms for generating trade orders based on Machine Learning models. You can choose from different strategies and customize the parameters. You can view your account balances and deploy trades based on ML-based algorithms.

Data Analysis

With Sibyl, you can analyze historical data, perform technical analysis, and generate insights to inform your trading decisions.

API Reference

Sibyl provides a RESTful API for programmatic access. Use the API endpoints to retrieve data, place trade orders, and more.