Project Starter

Setup Instructions

  1. Clone the repo
  2. CD into the project folder
  3. Create the virtual environment
  4. Activate the virtual environment (VE)
  5. Install Requirements

Test Commands

  1. pytest run all tests
  2. pytest tests/test_main.py <- Run just the tests in this file
  3. pytest --pylint --cov <- Run Pylint and Coverage (Can be run independently)

Current Libraries Installed

  1. Pytest - Testing Framework
  2. Faker - Fake Data Creation
  3. Pytest Coverage
  4. Pytest Pylint

Adding Library

  1. Make sure you are in the correct VE, if not sure run "deactivate"
  2. Activate the VE
  3. Run pip freeze > requirements.txt