dbt-copilot-python 0.1.0__tar.gz → 0.1.2__tar.gz

{dbt_copilot_python-0.1.0 → dbt_copilot_python-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbt-copilot-python
-Version: 0.1.0
+Version: 0.1.2
 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
@@ -28,24 +28,46 @@ pip install dbt-copilot-python
 
 ### Usage
 
-In `settings.py`:
+In `settings.py`...
 
-1. Add the ECS container IP to `ALLOWED_HOSTS` so that the Application Load Balancer (ALB) healthcheck will succeed:
+#### ALLOWED_HOSTS
+
+Add the ECS container IP to `ALLOWED_HOSTS` so that the Application Load Balancer (ALB) healthcheck will succeed:
+
+```
+from dbt_copilot_python.network import setup_allowed_hosts
+
+ALLOWED_HOSTS = [...]
+
+ALLOWED_HOSTS = setup_allowed_hosts(ALLOWED_HOSTS)
+```
+
+#### DATABASES
+
+To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secrets Manager, there are two options.
+
+1. Configure the `DATABASES` setting to use a database URL (recommended):
+
+    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`.
 
     ```
-    from dbt_copilot_python.network import setup_allowed_hosts
-    
-    ALLOWED_HOSTS = [...]
-    
-    ALLOWED_HOSTS = setup_allowed_hosts(ALLOWED_HOSTS)
+    import dj_database_url
+
+    from dbt_copilot_python.database import database_url_from_env
+   
+    DATABASES = {
+        "default": dj_database_url.config(
+            default=database_url_from_env("DATABASE_ENV_VAR_KEY")
+        )
+    }
     ```
 
-2. Configure the `DATABASES` setting from an RDS JSON object stored in SSM Parameter Store:
+2. Configure the `DATABASES` setting to use a dictionary containing the settings:
 
     ```
-    from dbt-copilot-python import aws_database_config
-   
-    DATABASES = aws_database_config("ENVIRONMENT_KEY")
+    from dbt-copilot-python.database import database_from_env
+
+    DATABASES = database_from_env("DATABASE_ENV_VAR_KEY")
     ```
 
 ## Contributing to `dbt-copilot-python`

dbt_copilot_python-0.1.2/README.md

@@ -0,0 +1,75 @@
+# DBT Copilot Python
+
+![](https://codebuild.eu-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiTG41bUNVdHN1b3NRS0hTYUlmMktLbnNNQzEyTlpMRDBlYlZiV1ZjNnl4b3dyMXl0R3VIUEVIbGVnYVJWbHd0OVZndVhURFpnckp5dWx0R0llMVpHUktzPSIsIml2UGFyYW1ldGVyU3BlYyI6ImthS3RRRUtOYkljSUVVUHMiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main)
+
+A set of utility functions for running Django & Flask apps in AWS ECS via AWS Copilot.
+
+## Using `dbt-copilot-python`
+
+### Installation
+
+```
+pip install dbt-copilot-python
+```
+
+### Usage
+
+In `settings.py`...
+
+#### ALLOWED_HOSTS
+
+Add the ECS container IP to `ALLOWED_HOSTS` so that the Application Load Balancer (ALB) healthcheck will succeed:
+
+```
+from dbt_copilot_python.network import setup_allowed_hosts
+
+ALLOWED_HOSTS = [...]
+
+ALLOWED_HOSTS = setup_allowed_hosts(ALLOWED_HOSTS)
+```
+
+#### DATABASES
+
+To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secrets Manager, there are two options.
+
+1. Configure the `DATABASES` setting to use a database URL (recommended):
+
+    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`.
+
+    ```
+    import dj_database_url
+
+    from dbt_copilot_python.database import database_url_from_env
+   
+    DATABASES = {
+        "default": dj_database_url.config(
+            default=database_url_from_env("DATABASE_ENV_VAR_KEY")
+        )
+    }
+    ```
+
+2. Configure the `DATABASES` setting to use a dictionary containing the settings:
+
+    ```
+    from dbt-copilot-python.database import database_from_env
+
+    DATABASES = database_from_env("DATABASE_ENV_VAR_KEY")
+    ```
+
+## Contributing to `dbt-copilot-python`
+
+### Requirements
+
+- [Poetry](https://python-poetry.org/); `pip install poetry`
+
+### Install dependencies & pre-commit hooks
+
+```
+poetry install && poetry run pre-commit install
+```
+
+### Run the tests
+
+```
+poetry run pytest
+```

{dbt_copilot_python-0.1.0 → dbt_copilot_python-0.1.2}/dbt_copilot_python/database.py

@@ -29,3 +29,17 @@ def database_from_env(environment_key, **extra_keys):
     """
 
     return {"default": setup_database(environment_key, **extra_keys)}
+
+
+def database_url_from_env(environment_key):
+    """
+    Set up the default database URL from a Copilot database environment
+    variable.
+
+    Usage in settings.py:
+
+    DATABASES = { 'default': dj_database_url.config(default=database_url_from_env("MY_DATABASE")) }
+    """
+    config = json.loads(os.environ[environment_key])
+
+    return "{engine}://{username}:{password}@{host}:{port}/{dbname}".format(**config)

{dbt_copilot_python-0.1.0 → dbt_copilot_python-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dbt-copilot-python"
-version = "0.1.0"
+version = "0.1.2"
 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"

dbt_copilot_python-0.1.0/README.md

@@ -1,53 +0,0 @@
-# DBT Copilot Python
-
-![](https://codebuild.eu-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiTG41bUNVdHN1b3NRS0hTYUlmMktLbnNNQzEyTlpMRDBlYlZiV1ZjNnl4b3dyMXl0R3VIUEVIbGVnYVJWbHd0OVZndVhURFpnckp5dWx0R0llMVpHUktzPSIsIml2UGFyYW1ldGVyU3BlYyI6ImthS3RRRUtOYkljSUVVUHMiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main)
-
-A set of utility functions for running Django & Flask apps in AWS ECS via AWS Copilot.
-
-## Using `dbt-copilot-python`
-
-### Installation
-
-```
-pip install dbt-copilot-python
-```
-
-### Usage
-
-In `settings.py`:
-
-1. Add the ECS container IP to `ALLOWED_HOSTS` so that the Application Load Balancer (ALB) healthcheck will succeed:
-
-    ```
-    from dbt_copilot_python.network import setup_allowed_hosts
-    
-    ALLOWED_HOSTS = [...]
-    
-    ALLOWED_HOSTS = setup_allowed_hosts(ALLOWED_HOSTS)
-    ```
-
-2. Configure the `DATABASES` setting from an RDS JSON object stored in SSM Parameter Store:
-
-    ```
-    from dbt-copilot-python import aws_database_config
-   
-    DATABASES = aws_database_config("ENVIRONMENT_KEY")
-    ```
-
-## Contributing to `dbt-copilot-python`
-
-### Requirements
-
-- [Poetry](https://python-poetry.org/); `pip install poetry`
-
-### Install dependencies & pre-commit hooks
-
-```
-poetry install && poetry run pre-commit install
-```
-
-### Run the tests
-
-```
-poetry run pytest
-```