Internal service endpoint health check for the Spatial Support System.
The recommended way to set up this project for development is using Poetry to install and manage a virtual Python environment. With Poetry installed, change into the project directory and run:
poetry install
Activate the virtualenv like so:
poetry shell
To run Python commands in the activated virtualenv, thereafter run them as normal:
python manage.py
Manage new or updating project dependencies with Poetry also, like so:
poetry add newpackage==1.0
This project uses python-dotenv to set environment variables (in a .env file).
Most settings have default values; check status.py for required variables.
Use python status.py to run a local copy of the application:
python status.py
The application runs on port 8080 by default. To change this, set an environment
variable value for PORT.
To build a new Docker image from the Dockerfile:
docker image build -t ghcr.io/dbca-wa/healthcheck .
To run a Docker container locally, publishing container port 8080 to a local port:
docker container run --rm --publish 8080:8080 --env-file .env ghcr.io/dbca-wa/healthcheck
This project includes the following pre-commit hooks:
- TruffleHog (credential scanning): https://github.com/marketplace/actions/trufflehog-oss
Pre-commit hooks may have additional system dependencies to run. Optionally install pre-commit hooks locally like so:
pre-commit install
Reference: https://pre-commit.com/