load_configuration: Load minid configuration object from config file

In bheavner/minidtools: Working with the BD2K Minimal Viable Identifier

Description

Before using the minid API to mint a new minid, you first need to validate your email address (using register_user()). Following registration, a unique code will be sent to your email address. You must present this code along with your email address when accessing the API.

Usage

load_configuration(config_file = "~/.minid/minid-config.json")

Arguments

config_file

Path to the configuration file (default "~/.minid/minid-config.json")

Details

As a convenience you can specify this information in a minid configuration file (default location is ~/.minid/minid-config.json).

load_configuration() loads the json- or python-style config file and returns a configuration object.

Value

An object of type "configuration"

Examples

## Not run: 

configuration <-
  load_configuration(config_file = "~/.minid/minid-config.json")

## End(Not run)

bheavner/minidtools documentation built on Aug. 3, 2020, 4:05 a.m.