search

CSXL / Momentum-investing-Strategy

A strategy that predicts which stocks to buy depending on the following return the asset has made over the following years.
MIT License
2 stars 0 forks source link

Refactor Project #1

Open ecsbeats opened 2 years ago

ecsbeats commented 2 years ago

Status issue of the refactoring branch of the project. Branch Link

ecsbeats commented 2 years ago

Steps

Before Refactoring i. Configure my development environment . Package management (Poetry ENV with requirements) . Setup API (IEX Cloud) *. Fill configuration values locally ii. Run program on my machine iii. Examine functionality and develop a mental idea of the program

Pre Processing

  1. Install and configure pylint with pylintrc *. Run pylint to get a general idea of code quality
  2. Setup file rulers according to PEP guidelines *. Comments/Docstrings max is 72, lines of code max (with some exceptions) is 79
  3. Fix spacing and line length to make development easier
  4. Run program

Testing

  1. Set up testing environment . File & Directory structure . Run a trial test
  2. Build a set of tests to cover requirements

Refactor Loop

  1. Write failing test
  2. Refactor code to pass test
  3. Repeat