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.

Source Distribution

openregister-0.8.9.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

openregister-0.8.9-py3-none-any.whl (30.0 kB view details)

Uploaded Python 3

File details

Details for the file openregister-0.8.9.tar.gz.

File metadata

  • Download URL: openregister-0.8.9.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for openregister-0.8.9.tar.gz
Algorithm Hash digest
SHA256 984b528f1f02d7e74704ad2ae134fd7254e742a53c62c0b5c25689ebb00122be
MD5 e7d82a1fc43b183adb33dd777cee70ed
BLAKE2b-256 c30dcc2f7f5278e26bd4ddfbec625913f2dd37ba9679dc3ca1f41494537d30a9

See more details on using hashes here.

File details

Details for the file openregister-0.8.9-py3-none-any.whl.

File metadata

  • Download URL: openregister-0.8.9-py3-none-any.whl
  • Upload date:
  • Size: 30.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for openregister-0.8.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e45fe45c5c5fca365ba314e57c594a9330993114af72485d4e99646b367518ad
MD5 363af4dc68dab3217376c8b2317371d7
BLAKE2b-256 d20d78da06cc5c2a4762432556f77386a407093a1ad780c609179dc0704b7a6b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page