• Install dependencies for system:

  Linux:

  pip install pipenv

  Windows:

  In powershell as admin:

  pip install pipenv

  On Windows you may need to add the path to pipenv to your PATH environment variable, it will be printed at the end of the install command most likely

• To install dependencies:

  pipenv install

  To run:

  pipenv run python src/gmail_search_extractor.py

• To make changes to requirements.txt, change the file and then:

  pipenv --rm
  rm Pipfile.lock
  rm Pipfile
  pipenv install # to use the new requirements.txt

• To enter bash in the virtual environment:

  pipenv shell

• To Activate or Source the environment and not have to prepend each command with pipenv:

  On Linux:

  source $(pipenv --venv)/bin/activate

  On Windows (Powershell):

  & "$(pipenv --venv)\Scripts\activate.ps1"

• To Deactivate:

  deactivate

To Build and run the docker image:

docker build -t gmail_extractor .
docker run -it gmail_extractor /bin/bash

To run tests:

cd tests
pytest # include name of test_file.py to run specific test

To exit:

exit