Update to use poetry package manager (#43)

Author: petechd

.github/workflows/pull_request.yaml

@@ -15,9 +15,15 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Install Pipenv
-        run: pip install pipenv
-      - name: Install virtual environment with dev dependencies
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.8.3
+          virtualenvs-create: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install virtual environment
         run: make install-dev
       - name: Running lint tests
         run: make lint

Makefile

@@ -11,27 +11,27 @@ help:
 	@echo " * make run-debug ... run locally using functions-framework"
 
 install:
-	pipenv install
-	pipenv requirements > requirements.txt
+	poetry install
+	poetry export --without-hashes --format=requirements.txt > requirements.txt
 
 install-dev:
-	pipenv install --dev
+	poetry install
 
 deploy_function: install
 	./scripts/deploy_function.sh
 
 delete_function:
-	pipenv run ./scripts/delete_function.sh
+	poetry run ./scripts/delete_function.sh
 
 format:
-	pipenv run black . tests
-	pipenv run isort . tests
+	poetry run black . tests
+	poetry run isort . tests
 
 lint:
-	pipenv run ./scripts/run_lint.sh
+	poetry run ./scripts/run_lint.sh
 
 test:
-	pipenv run ./scripts/run_tests.sh
+	poetry run ./scripts/run_tests.sh
 
 run-debug:
-	pipenv run functions-framework --target=send_email --debug
+	poetry run functions-framework --target=send_email --debug

Pipfile

@@ -8,7 +8,7 @@ On instantiation the function forwards the request on to Gov Notify, which is re
 
 ## Development
 
-Local development uses Pipenv to manage the Python environment. Make sure you have Pipenv installed and are using Python version 3.11.
+Local development uses Poetry to manage the Python environment. Make sure you have Poetry installed and are using Python version 3.11.
 
 There are two environment variables required to run the function:
 

Pipfile.lock

@@ -24,6 +24,6 @@ run:
       gcloud config set project "${PROJECT_ID}"
 
       cd eq-submission-confirmation-consumer
-      pip3 install pipenv
-      pipenv requirements > requirements.txt
+      pip3 install poetry
+      poetry export --without-hashes --format=requirements.txt > requirements.txt
       ./scripts/deploy_function.sh

README.md

@@ -0,0 +1,30 @@
+[tool.poetry]
+name = "eq-submission-confirmation-consumer"
+version = "1.0.0"
+description = "ONS Digital eQ Submission Confirmation Consumer App"
+authors = ["ONSDigital"]
+package-mode = false
+
+[tool.poetry.dependencies]
+python = "^3.11"
+flask = "*"
+google-cloud-secret-manager = "*"
+pyjwt = "*"
+requests = "*"
+functions-framework = "*"
+
+[tool.poetry.group.dev.dependencies]
+pylint = "^2.17.7"
+black = "*"
+mypy = "*"
+pytest = "*"
+flake8 = "*"
+pylint-quotes = "*"
+responses = "*"
+pytest-cov = "*"
+python-dotenv = "*"
+types-requests = "*"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

ci/deploy_function.yaml

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 
-pipenv run mypy --ignore-missing-imports *.py tests
+poetry run mypy --ignore-missing-imports *.py tests

poetry.lock

@@ -15,7 +15,7 @@ def notify_function_process():
 
     # pylint: disable=consider-using-with
     process = subprocess.Popen(
-        ["pipenv run functions-framework --target=send_email --debug"],
+        ["poetry run functions-framework --target=send_email --debug"],
         cwd=cwd,
         stdout=subprocess.PIPE,
         shell=True,