ov-wag 1.1.0

WGBH Open Vault Wagtail backend

Open Vault: Wagtail

From GBH

Wagtail CMS for Open Vault

Documentation

User Documentation

Usage

Install

The published version can be installed using pip:

pip install ov-wag

Local installation

For local development, install uv for dependency management.

pip install uv

Clone the repo:

git clone https://github.com/WGBH-MLA/ov-wag.git

Install development dependencies:

uv sync

Scripts

Common functions can be executed as files in the scripts/ directory

See scripts/ for detailed usage on each.

Examples

./scripts/dev will start the development server locally.

Note For most commands, additional args will be passed on to the parent command.

• dev | d
  • starts a local development server
• build | b
  • build (or rebuild) the docker image
• shell | s
  • starts a shell with all django variables loaded
• manage | m
  • run a manage.py command
• cmd | c
  • run a command directly on the container
  • e.g.
    • ov c bash
    • ov c python3 -c "print('OpenVault!')"

develop

pre-commit secret scanning

0. Install ggshield

pip install ggshield
# or
brew install gitguardian/tap/ggshield

1. Login to gitguardian

ggshield auth login

2. Install the pre-commit hooks

pre-commit install

Credits

Created by the Media Library and Archives at GBH