README.md

stock-screener

Local Environment Setup

• Download mongo db from docker using following command

    docker pull mongo

• Start mongo on local machine using

    docker run -d -p 27017:27017 mongo:latest

• Install all required dependencies

    pip3 install -r requirements.txt

Development enviornment

• Run test cases

    tox -epy38

• Run static code analysis

    tox -epep8

• Run coverage

    tox -ecover

Run screener for development on local

    python3/python screener.py screen --t=stock/index/sector --config-file=<yaml config file>

Package project in docker image

• Go to project folder
• Build docker image

    docker build -t screener:latest -f Dockerfile .

NOTE: Now docker image is ready