Overview

Interact with the RackN Digital Rebar API (in a way that's useful to us).

• Free software: Apache Software License 2.0

Installation

pip install pyprotonrebar

You can also install the in-development version with:

pip install git+ssh://git@github.com/ProtonMail/pyprotonrebar.git@main

Documentation

While primarily intended as common code for https://github.com/ProtonMail/proton.rackndr, it can also be used as is.

For example, to use the project to create a new Param:

import pyprotonrebar.pyrackndr
TOKEN = pyprotonrebar.pyrackndr.fetch_token_requests(
    'superuser',
    'user:pass',
    'https://localhost:8092')
AUTH = TOKEN['header']

rebar_object = pyprotonrebar.pyrackndr.RackNDr(
    'https://localhost:8092',
    AUTH,
    'params')

data = pyprotonrebar.CONSTANTS['params'].copy()
data['Description'] = 'new-param description goes here'
data['Documentation'] = 'new-param documentation goes here'
data['Name'] = 'new-param'
data['Secure'] = False
data['Schema'] = {
  'type': 'string',
  'default': 'hello'
}

rebar_object.create(data)

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox