dbt-copilot-python 0.1.5.dev1__tar.gz → 0.1.5.dev2__tar.gz

{dbt_copilot_python-0.1.5.dev1 → dbt_copilot_python-0.1.5.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbt-copilot-python
-Version: 0.1.5.dev1
+Version: 0.1.5.dev2
 Summary: Helper functions to run Django and Flask applications in AWS Copilot/ECS.
 Author: Department for Business and Trade Platform Team
 Author-email: sre-team@digital.trade.gov.uk
@@ -16,6 +16,9 @@ Requires-Dist: opentelemetry-exporter-otlp (==1.22.0)
 Requires-Dist: opentelemetry-instrumentation-wsgi (==0.43b0)
 Requires-Dist: opentelemetry-propagator-aws-xray (>=1.0.1,<2.0.0)
 Requires-Dist: opentelemetry-sdk-extension-aws (>=2.0.1,<3.0.0)
+Requires-Dist: pytest-celery (>=0.0.0,<0.0.1)
+Requires-Dist: pytest-mock (>=3.12.0,<4.0.0)
+Requires-Dist: redis (>=5.0.1,<6.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Description-Content-Type: text/markdown
 
@@ -29,7 +32,7 @@ A set of utility functions for running Django & Flask apps in AWS ECS via AWS Co
 
 ### Installation
 
-```
+```shell
 pip install dbt-copilot-python
 ```
 
@@ -39,7 +42,7 @@ pip install dbt-copilot-python
 
 Add the ECS container IP to `ALLOWED_HOSTS` setting so that the Application Load Balancer (ALB) healthcheck will succeed:
 
-```
+```python
 from dbt_copilot_python.network import setup_allowed_hosts
 
 ALLOWED_HOSTS = [...]
@@ -49,6 +52,17 @@ ALLOWED_HOSTS = setup_allowed_hosts(ALLOWED_HOSTS)
 
 #### Celery health check
 
+Add the health check in your application's Celery config file...
+
+```python
+from dbt_copilot_python.celery_health_check import healthcheck
+
+celery_app = Celery("application_name")
+...
+
+celery_app = healthcheck.setup(celery_app)
+```
+
 Add the health check to the Celery worker service in `docker-compose.yml`...
 
 ```yaml
@@ -79,7 +93,7 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
 
     Note: This is dependent on the [`dj-database-url`](https://pypi.org/project/dj-database-url/) package which can be installed via `pip install dj-database-url`.
 
-    ```
+    ```python
     import dj_database_url
 
     from dbt_copilot_python.database import database_url_from_env
@@ -93,7 +107,7 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
 
 2. Configure the `DATABASES` setting to use a dictionary containing the settings:
 
-    ```
+    ```python
     from dbt-copilot-python.database import database_from_env
 
     DATABASES = database_from_env("DATABASE_ENV_VAR_KEY")
@@ -107,13 +121,13 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
 
 ### Install dependencies & pre-commit hooks
 
-```
+```shell
 poetry install && poetry run pre-commit install
 ```
 
 ### Run the tests
 
-```
+```shell
 poetry run pytest
 ```
 
@@ -128,7 +142,7 @@ To publish the Python package `dbt-copilot-python`, you will need an API token.
 
 Update the version, as the same version cannot be published to PyPi.
 
-```
+```shell
 poetry version patch
 ```
 
@@ -136,7 +150,7 @@ More options for the `version` command can be found in the [Poetry documentation
 
 Build the Python package.
 
-```
+```shell
 poetry build
 ```
 
@@ -144,7 +158,7 @@ Publish the Python package.
 
 _Note: Make sure your Pull Request (PR) is approved and contains the version upgrade in `pyproject.toml` before publishing the package._
 
-```
+```shell
 poetry publish
 ```
 

{dbt_copilot_python-0.1.5.dev1 → dbt_copilot_python-0.1.5.dev2}/README.md

@@ -8,7 +8,7 @@ A set of utility functions for running Django & Flask apps in AWS ECS via AWS Co
 
 ### Installation
 
-```
+```shell
 pip install dbt-copilot-python
 ```
 
@@ -18,7 +18,7 @@ pip install dbt-copilot-python
 
 Add the ECS container IP to `ALLOWED_HOSTS` setting so that the Application Load Balancer (ALB) healthcheck will succeed:
 
-```
+```python
 from dbt_copilot_python.network import setup_allowed_hosts
 
 ALLOWED_HOSTS = [...]
@@ -28,6 +28,17 @@ ALLOWED_HOSTS = setup_allowed_hosts(ALLOWED_HOSTS)
 
 #### Celery health check
 
+Add the health check in your application's Celery config file...
+
+```python
+from dbt_copilot_python.celery_health_check import healthcheck
+
+celery_app = Celery("application_name")
+...
+
+celery_app = healthcheck.setup(celery_app)
+```
+
 Add the health check to the Celery worker service in `docker-compose.yml`...
 
 ```yaml
@@ -58,7 +69,7 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
 
     Note: This is dependent on the [`dj-database-url`](https://pypi.org/project/dj-database-url/) package which can be installed via `pip install dj-database-url`.
 
-    ```
+    ```python
     import dj_database_url
 
     from dbt_copilot_python.database import database_url_from_env
@@ -72,7 +83,7 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
 
 2. Configure the `DATABASES` setting to use a dictionary containing the settings:
 
-    ```
+    ```python
     from dbt-copilot-python.database import database_from_env
 
     DATABASES = database_from_env("DATABASE_ENV_VAR_KEY")
@@ -86,13 +97,13 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
 
 ### Install dependencies & pre-commit hooks
 
-```
+```shell
 poetry install && poetry run pre-commit install
 ```
 
 ### Run the tests
 
-```
+```shell
 poetry run pytest
 ```
 
@@ -107,7 +118,7 @@ To publish the Python package `dbt-copilot-python`, you will need an API token.
 
 Update the version, as the same version cannot be published to PyPi.
 
-```
+```shell
 poetry version patch
 ```
 
@@ -115,7 +126,7 @@ More options for the `version` command can be found in the [Poetry documentation
 
 Build the Python package.
 
-```
+```shell
 poetry build
 ```
 
@@ -123,7 +134,7 @@ Publish the Python package.
 
 _Note: Make sure your Pull Request (PR) is approved and contains the version upgrade in `pyproject.toml` before publishing the package._
 
-```
+```shell
 poetry publish
 ```
 

{dbt_copilot_python-0.1.5.dev1 → dbt_copilot_python-0.1.5.dev2}/dbt_copilot_python/celery_health_check/healthcheck.py

@@ -1,29 +1,30 @@
 # See https://medium.com/ambient-innovation/health-checks-for-celery-in-kubernetes-cf3274a3e106
 
 import sys
+from datetime import UTC
 from datetime import datetime
 
 from celery import signals
-from dateutil.tz import tz
 
 from .const import HEARTBEAT_FILE
 from .const import READINESS_FILE
-from .liveness_probe import LivenessProbe
+from .heartbeat import HeartBeat
 
 
-def worker_ready(**_):
+def on_worker_ready(**_):
     READINESS_FILE.touch()
 
 
-def worker_shutdown(**_):
+def on_worker_shutdown(**_):
     READINESS_FILE.unlink(missing_ok=True)
 
 
 def setup(celery_app=None):
-    signals.worker_ready.connect(worker_ready)
-    signals.worker_shutdown.connect(worker_shutdown)
+    signals.worker_ready.connect(on_worker_ready)
 
-    celery_app.steps["worker"].add(LivenessProbe)
+    signals.worker_shutdown.connect(on_worker_shutdown)
+
+    celery_app.steps["worker"].add(HeartBeat)
     return celery_app
 
 
@@ -37,7 +38,7 @@ def check_health():
         sys.exit(1)
 
     heartbeat_timestamp = float(HEARTBEAT_FILE.read_text())
-    current_timestamp = datetime.timestamp(datetime.now(tz=tz.UTC))
+    current_timestamp = datetime.now(UTC).timestamp()
     time_diff = current_timestamp - heartbeat_timestamp
     if time_diff > 60:
         print(

dbt_copilot_python-0.1.5.dev1/dbt_copilot_python/celery_health_check/liveness_probe.py → dbt_copilot_python-0.1.5.dev2/dbt_copilot_python/celery_health_check/heartbeat.py

@@ -1,13 +1,12 @@
+from datetime import UTC
 from datetime import datetime
 
 from celery import bootsteps
-from dateutil.tz import tz
 
 from .const import HEARTBEAT_FILE
 
 
-# Todo: Should we call this "HeartBeat"?
-class LivenessProbe(bootsteps.StartStopStep):
+class HeartBeat(bootsteps.StartStopStep):
     requires = {"celery.worker.components:Timer"}
 
     def __init__(self, parent, **kwargs):
@@ -27,4 +26,4 @@ class LivenessProbe(bootsteps.StartStopStep):
         HEARTBEAT_FILE.unlink(missing_ok=True)
 
     def update_heartbeat_file(self, worker):
-        HEARTBEAT_FILE.write_text(str(datetime.timestamp(datetime.now(tz=tz.UTC))))
+        HEARTBEAT_FILE.write_text(str(datetime.timestamp(datetime.now(UTC))))

{dbt_copilot_python-0.1.5.dev1 → dbt_copilot_python-0.1.5.dev2}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "dbt-copilot-python"
-version = "0.1.5-dev1"
+version = "0.1.5-dev2"
 description = "Helper functions to run Django and Flask applications in AWS Copilot/ECS."
 authors = ["Department for Business and Trade Platform Team <sre-team@digital.trade.gov.uk>"]
 readme = "README.md"
@@ -18,6 +18,9 @@ opentelemetry-instrumentation-wsgi = "0.43b0"
 opentelemetry-propagator-aws-xray = "^1.0.1"
 opentelemetry-sdk-extension-aws = "^2.0.1"
 requests = "^2.31.0"
+pytest-celery = "^0.0.0"
+redis = "^5.0.1"
+pytest-mock = "^3.12.0"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.3.3"