Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.19 KB

INSTALL.md

File metadata and controls

44 lines (32 loc) · 1.19 KB
Raw

Installation Guide

Prerequisites

  • Windows | macOS | Linux
  • Python 3.8
  • Futu ID and Trading Account
  • FutuOpenD 6.1.2608

Setting Up the Virtual Environment

Step 1: Download and install conda from the official website. (If you prefer the light-weight miniconda, you can also install it from the miniconda website.)

Step 2: Run the following command on terminal to create a conda virtual environment and activate it:

conda create -n futubot python=3.8 -y
conda activate futubot

Installing FutuBot

Install FutuBot from source in order to run it on your virtual environment:

git clone https://github.com/quincylin1/futubot.git
cd futubot
pip install -r requirements.txt
pip install -v -e .
# "-v" for verbose option.
# "-e" means installing the project in editable mode,
# so any local modifications on the project can be used without reinstalling it.

Verify Your Installation

To verify FutuBot has been installed successfully, run the following:

python
>>> import futubot
>>> futubot.__version__
# Expected output: '1.0.0'