Installation

Follow the steps below to install pystocktopus locally.

Create a virtual environment

Create and activate a virtual environment

python -m venv tester_env

. env/bin/activate

Install dependencies

pystocktopus uses modern Python packaging and can be installed using pip -

python -m pip install pystocktopus

Setting-up Project

To use the software properly setup these API keys to completely use the features of the project:

1. Newsapi access from this.
2. Polygon.io API access from this.

Setup API Globally

#Polyon API KEY
export api_key="YOUR-API-KEY"

#NewsApi KEY
export news_api="YOUR-API-KEY"

Build pystocktopus from source

If you want to develop pystocktopus, or use its latest commit (!can be unstable!), you might want to install it from the source -

• Clone this repository

git clone https://github.com/Akhil-Sharma30/pystocktopus

• Change directory

cd pystocktopus

• Install the package in editable mode with the "dev" dependencies

python -m pip install -e ".[dev]"

Feel free to read our Contributing Guide for more information on developing pystocktopus.