4IRL / urls4irl

Sharing URL's with friends.
3 stars 0 forks source link

Slimming down python packages #194

Closed GPropersi closed 2 months ago

GPropersi commented 2 months ago

I broke the Python packages into three separate installation files -

  1. requirements-prod.txt - Includes packages only needed to run the website
  2. requirements-test.txt - Install all of prod and includes pytest for running CI actions testing. All GitHub Actions now use this file to install all packages up to testing
  3. requirements-dev.txt - Install all of test and includes pre-commit for commit check - we should be using this one

As devs on this project, we should install requirements-dev.txt in a clean virtual environment, and ensure the following (after activating the virtual environment)

To install the associated packages:

  1. Run python -m venv venv (ensure you are using 3.11.2)
  2. Activate the venv, depending on your OS. Your terminal should now start with (venv)
  3. Run pip install -r requirements-dev.txt
GPropersi commented 2 months ago

Confirmed works on my Linux laptop and Macbook, as well as the GitHub Action runners.