Update project settings and tox config

Author: hakbailey

.gitignore

@@ -16,7 +16,6 @@ pre-commit-user
 /.eggs
 .python-version
 
-
 # Testing
 .cache
 .coverage
@@ -49,3 +48,22 @@ tower-backup-*
 
 # DB
 db.sqlite3
+*.db
+
+# Environment variables
+.env
+.env.*
+*.env
+
+# Linting
+.mypy_cache/
+
+# Logs and temporary files
+*.log
+tmp/
+temp/
+
+# Virtual environments
+.venv/
+venv/
+env/

CONTRIBUTING.md

@@ -7,10 +7,13 @@ Hi there! We're excited to have you as a contributor.
 - [pattern-service](#pattern-service)
   - [Table of contents](#table-of-contents)
   - [Things to know prior to submitting code](#things-to-know-prior-to-submitting-code)
-    - [Build and Run the Development Environment](#build-and-run-the-development-environment)
-      - [Clone the repo](#clone-the-repo)
-      - [Configure python environment](#configure-python-environment)
-      - [Configure and run the application](#configure-and-run-the-application)
+  - [Build and Run the Development Environment](#build-and-run-the-development-environment)
+    - [Clone the repo](#clone-the-repo)
+    - [Configure Python environment](#configure-python-environment)
+    - [Set env variables for development](#set-env-variables-for-development)
+    - [Configure and run the application](#configure-and-run-the-application)
+  - [Updating dependencies](#updating-dependencies)
+  - [Running tests, linters, and code checks](#running-tests-linters-and-code-checks)
 
 ## Things to know prior to submitting code
 
@@ -19,15 +22,17 @@ Hi there! We're excited to have you as a contributor.
 - If collaborating with someone else on the same branch, consider using `--force-with-lease` instead of `--force`. This will prevent you from accidentally overwriting commits pushed by someone else. For more information, see [git push docs](https://git-scm.com/docs/git-push#git-push---force-with-leaseltrefnamegt).
 - We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions, or need assistance, please reach out to our community team at [[email protected]](mailto:[email protected])
 
-### Build and Run the Development Environment
+## Build and Run the Development Environment
 
-#### Clone the repo
+### Clone the repo
 
 If you have not already done so, you will need to clone, or create a local copy, of the [pattern-service repository](https://github.com/ansible/pattern-service).
 For more on how to clone the repo, view [git clone help](https://git-scm.com/docs/git-clone).
 Once you have a local copy, run the commands in the following sections from the root of the project tree.
 
-#### Configure python environment
+### Configure Python environment
+
+Ensure you are using a supported Python version, defined in the [pyproject.toml file](./pyproject.toml).
 
 Create python virtual environment using one of the below commands:
 
@@ -37,12 +42,37 @@ Set the virtual environment
 
 `source /path/to/virtualenv/bin/activate/`
 
-Install required python modules
+Install required python modules for development
+
+`pip install -r requirements/requirements-dev.txt`
+
+### Set env variables for development
 
-`pip install -r ./requirements-all.txt`
+Either create a .env file in the project root containing the following env variables, or export them to your shell env:
 
-#### Configure and run the application
+```bash
+PATTERN_SERVICE_MODE=development
+```
+
+### Configure and run the application
 
 `python manage.py migrate && python manage.py runserver`
 
-The application can be reached in your browser at `https://localhost:8000/`
+The application can be reached in your browser at `https://localhost:8000/`. The Django admin UI is accessible at `https://localhost:8000/admin` and the available API endpoints will be listed in the 404 information at `http://localhost:8000/api/pattern-service/v1/`.
+
+## Updating dependencies
+
+Project dependencies for all environments are specified in the [pyproject.toml file](./pyproject.toml). A requirements.txt file is generated for each environment using pip-compile, to simplify dependency installation with pip.
+
+To add a new dependency:
+
+1. Add the package to the appropriate project or optional dependencies section of the pyproject.toml file, using dependency specifiers to constrain versions.
+2. Update the requirements files with the command `make requirements`. This should update the relevant requirements.txt files in the project's requirements directory.
+
+## Running tests, linters, and code checks
+
+Unit tests, linters, type checks, and other checks can all be run via `tox`. To see the available `tox` commands for this project, run `tox list`.
+
+To run an individual tox command use the `-e` flag to specify the environment, for example: `tox -e test` to run tests with all supported python versions.
+s
+To run all tests and checks, simply run `tox` with no options.

Makefile

@@ -1,27 +1,43 @@
-.PHONY: build build-multi run test clean install-deps lint push-quay login-quay push-quay-multi
+.DEFAULT_GOAL := help
+
+.PHONY: help
+help: ## Show this help message
+	@grep -hE '^[a-zA-Z0-9._-]+:.*?##' $(MAKEFILE_LIST) | \
+	awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-24s\033[0m %s\n", $$1, $$2}' | \
+	sort -u
+
+
+# -------------------------------------
+# Container image
+# -------------------------------------
 
-# Image name and tag
 CONTAINER_RUNTIME ?= podman
-IMAGE_NAME ?= ansible-pattern-service
+IMAGE_NAME ?= pattern-service
 IMAGE_TAG ?= latest
+QUAY_NAMESPACE ?= ansible
 
-# Build the Docker image
-build:
+.PHONY: build
+build: ## Build the container image
 	@echo "Building container image..."
 	$(CONTAINER_RUNTIME) build -t $(IMAGE_NAME):$(IMAGE_TAG) -f Dockerfile.dev --arch amd64 .
 
-ensure-namespace:
-ifndef QUAY_NAMESPACE
-$(error QUAY_NAMESPACE is required to push quay.io)
-endif
-
-# Clean up
-clean:
+.PHONY: clean
+clean: ## Remove container image
 	@echo "Cleaning up..."
 	$(CONTAINER_RUNTIME) rmi -f $(IMAGE_NAME):$(IMAGE_TAG) || true
 
-# Tag and push to Quay.io
-push: ensure-namespace build
-	@echo "Tagging and pushing to registry..."
+.PHONY: push
+push: ensure-namespace build ## Tag and push container image to Quay.io
+	@echo "Tagging and pushing to quay.io/$(QUAY_NAMESPACE)/$(IMAGE_NAME):$(IMAGE_TAG)..."
 	$(CONTAINER_RUNTIME) tag $(IMAGE_NAME):$(IMAGE_TAG) quay.io/$(QUAY_NAMESPACE)/$(IMAGE_NAME):$(IMAGE_TAG)
 	$(CONTAINER_RUNTIME) push quay.io/$(QUAY_NAMESPACE)/$(IMAGE_NAME):$(IMAGE_TAG)
+
+# -------------------------------------
+# Dependencies
+# -------------------------------------
+
+.PHONY: requirements
+requirements: ## Generate requirements.txt files from pyproject.toml
+	pip-compile -o requirements/requirements.txt pyproject.toml
+	pip-compile --extra dev --extra test -o requirements/requirements-dev.txt pyproject.toml
+	pip-compile --extra test -o requirements/requirements-test.txt pyproject.toml

pattern_service/settings/__init__.py

@@ -1,7 +1,27 @@
+import os
+
 from ansible_base.lib.dynamic_config import export
 from ansible_base.lib.dynamic_config import factory
+from ansible_base.lib.dynamic_config import load_envvars
+from ansible_base.lib.dynamic_config import load_standard_settings_files
+
+try:
+    from dotenv import load_dotenv
+
+    load_dotenv()
+except ImportError:
+    pass
+os.environ["PATTERN_SERVICE_MODE"] = os.environ.get(
+    "PATTERN_SERVICE_MODE", "production"
+)
 
 # Django Ansible Base Dynaconf settings
-DYNACONF = factory(__name__, "PATTERN_SERVICE", settings_files=["defaults.py"])
-# manipulate DYNACONF as needed
+DYNACONF = factory(
+    __name__,
+    "PATTERN_SERVICE",
+    environments=("development", "production", "testing"),
+    settings_files=["defaults.py"],
+)
+load_standard_settings_files(DYNACONF)
+load_envvars(DYNACONF)
 export(__name__, DYNACONF)

pattern_service/settings/defaults.py

@@ -11,23 +11,10 @@
 """
 
 from pathlib import Path
-from typing import List
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
-
-
-# Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/
-
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = "django-insecure-_f^+pc=x%dd&p8ht4qv7rqr8&a%@j#lda6v!x9353m+)fm8&gk"
-
-# SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
-
-ALLOWED_HOSTS: List[str] = ["localhost", "pattern-service", "127.0.0.1"]
-
+DEBUG = False
 
 # Application definition
 
@@ -72,23 +59,14 @@
 WSGI_APPLICATION = "pattern_service.wsgi.application"
 
 
-# Database
-# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
-
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": BASE_DIR / "db.sqlite3",
-    }
-}
-
-
 # Password validation
 # https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+        "NAME": (
+            "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
+        ),
     },
     {
         "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",

pattern_service/settings/development_defaults.py

@@ -0,0 +1,49 @@
+from pathlib import Path
+
+ALLOWED_HOSTS = ["localhost", "pattern-service", "127.0.0.1"]
+BASE_DIR = Path(__file__).resolve().parent.parent
+DEBUG = True
+SECRET_KEY = (
+    "django-insecure-_f^+pc=x%dd&p8ht4qv7rqr8&a%@j#lda6v!x9353m+)fm8&gk"  # notsecret
+)
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+# Logging
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "simple": {
+            "format": "{levelname} {name} {lineno} {message}",
+            "style": "{",
+        },
+    },
+    "handlers": {
+        "console": {
+            "level": DEBUG,
+            "class": "logging.StreamHandler",
+            "formatter": "simple",
+        },
+    },
+    "filters": {"require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}},
+    "loggers": {
+        "ansible_base": {
+            "handlers": ["console"],
+            "level": "DEBUG",
+        },
+        "core": {
+            "handlers": ["console"],
+            "level": "DEBUG",
+        },
+        "django": {
+            "handlers": ["console"],
+            "level": "INFO",
+        },
+    },
+}

pattern_service/settings/testing_defaults.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+
+ALLOWED_HOSTS = ["localhost", "pattern-service", "127.0.0.1"]
+BASE_DIR = Path(__file__).resolve().parent.parent
+SECRET_KEY = (
+    "django-insecure-_f^+pc=x%dd&p8ht4qv7rqr8&a%@j#lda6v!x9353m+)fm8&gk"  # notsecret
+)
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}