Skip to content

WGBH-MLA/ov-wag

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CI Coverage Status

Open Vault: Wagtail

From GBH

Wagtail CMS for Open Vault

Documentation

Usage

Install

The published version can be installed using pip:

pip install ov-wag

Local installation

For local devopment, install PDM for dependency management.

pip install pdm

Clone the repo:

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

Install the package:

pdm install

Init script

Several common functions can be executed with the ov init script (using Docker)

See ov -h for more detailed usage

For example

ov 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

  1. Install ggshield
pip install ggshield
# or
brew install gitguardian/tap/ggshield
  1. Login to gitguardian
ggshield auth login
  1. Install the pre-commit hooks
pre-commit install