Skip to main content

Publishing tools for GOV.UK style registers

Project description

OpenRegister

Package PyPI - Python Version Build Coverage License Code style: black

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 options

$ 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 options

$ openregister serve --help

Usage: openregister serve [OPTIONS]

Options:
  -h, --host TEXT      host for server, defaults to 127.0.0.1
  -r, --register TEXT  Serve a single register, otherwise serve all know
                       registers as a catalog
  -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

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

make init
make
python -m openregister --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for openregister, version 0.8.9
Filename, size File type Python version Upload date Hashes
Filename, size openregister-0.8.9-py3-none-any.whl (30.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size openregister-0.8.9.tar.gz (15.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page