OpenRegister

Publishing tools for GOV.UK style registers.

A self-contained and easily installed GOV.UK register product intended for use by devolved authorities and administrations.

Installation

pip3 install openregister

Basic usage

openregister serve /path/to/register.json

Runs a web server serving an index of registers on http://localhost:8088/

Command line

$ openregister --help

Usage: openregister [OPTIONS] COMMAND [ARGS]...

  OpenRegister:  publishing tools for GOV.UK style registers.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  serve*

Server command

$ openregister serve --help

Usage: openregister serve [OPTIONS]

Options:
  -h, --host TEXT      host for server, defaults to 127.0.0.1
  -p, --port INTEGER   port for server, defaults to 8088
  -d, --debug          More verbose logging and automatically reload on
                       changes
  --help               Show this message and exit.

Development environment

Development requires Python 3.5 or later, we recommend using a virtual environment:

make init
make
python -m openregister --help

Release procedure

Update the tagged version number:

make bump

Build the wheel and egg files:

make dist

Push to GitHub:

git push && git push --tags

Wait for the continuous integration tests to pass and then upload to PyPI:

make upload