Metadata-Version: 2.1
Name: BullETS
Version: 0.0.1a0
Summary: BullETS is a Python package designed to help with the development of algorithmic trading strategies.
Home-page: https://github.com/AlgoETS/BullETS
Author: AlgoÉTS
License: Apache 2.0
Description: # BullETS
        
        ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/AlgoETS/BullETS/Build/main?label=Checks%20%28main%29)
        
        BullETS is a Python library designed to help with the development of algorithmic trading strategies.
        
        ## Upcoming features
        
        - Retrieve stock data
        - Trading portfolio management
        - Backtesting framework
        
        ## Installation
        
        This section will assume you have **Python** installed, if not, you can download & install it from [here](https://www.python.org/downloads/).
        
        ### Development mode
        
        This section covers the installation process if you wish to **contribute** to the library. We recommend using a [virtual environment](https://docs.python.org/3/library/venv.html) to keep BullETS and its dependencies from interfering with your system installs.
        
        1. Clone the repo and go to the library's root directory
        ``` shell
        # Clone this repository
        git clone https://github.com/AlgoETS/BullETS
        
        # Move to the BullETS directory
        cd BullETS
        ```
        2. Initialize and run the virtual environment (Windows)
        ```shell
        # Initializing a virtual environment in the ./venv directory
        py -3 -m venv venv
        
        # Activating the virtual environment
        venv\Scripts\activate.bat
        ```
        
        2. Initialize and run the virtual environment (Mac OS & Linux)
        ```shell
        # Initializing a virtual environment in the ./venv directory
        python3 -m venv bot-env
        
        # Activating the virtual environment (Mac OS & Linux)
        source bot-env/bin/activate
        ```
        
        3. Install BullETS in editable mode (while the virtual environment is activated)
        ```shell
        pip install -e .
        ```
        
        4. Setup environment variables 
           1. Make a copy of the `.env.sample` file and name it `.env`
           2. Replace the required values inside the `.env` file
        
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
