This project consists of the Integrated Business Management System (IBMS) corporate application, used by the Department of Biodiversity, Conservation and Attractions.
The recommended way to set up this project for development is using
uv
to install and manage a Python virtual environment.
With uv installed, install the required Python version (see pyproject.toml). Example:
uv python install 3.12
Change into the project directory and run:
uv python pin 3.12
uv sync
Activate the virtualenv like so:
source .venv/bin/activate
To run Python commands in the activated virtualenv, thereafter run them like so:
python manage.py
Manage new or updated project dependencies with uv also, like so:
uv add newpackage==1.0
This project uses environment variables (in a .env file) to define application settings.
Required settings are as follows:
DATABASE_URL="postgis://USER:PASSWORD@HOST:PORT/DATABASE_NAME"
SECRET_KEY="ThisIsASecretKey"
Use runserver to run a local copy of the application:
python manage.py runserver 0:8080
Run console commands manually:
python manage.py shell_plus
To build a new Docker image from the Dockerfile:
docker image build -t ghcr.io/dbca-wa/ibms .
This project includes the following pre-commit hooks:
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/