Welcome to pynio’s documentation!¶

pynio is a Python SDK for interacting with a running n.io instance.

Contents:

Instance¶

class pynio.instance.Instance(host='127.0.0.1', port=8181, creds=None)[source]¶

Interface for a running n.io instance.

This is the main part of pynio. All communication with the n.io instance goes through this object. Blocks and Services contain a reference to an Instance in order to communication with the running instance.

Parameters:	host (str, optional) – Host ip address of running n.io instance. Default is ‘127.0.0.1’. port (int, optional) – Port of runing n.io instance. Default is 8181. creds ((str, str), optional) – Username and password for basic authentication. Default is (‘Admin’, ‘Admin’).

blocks¶

dict of Block

A collection of block names with their Block instance.

services¶

dict of Service

A collection of service names with their Service instance.

DELETE_ALL()[source]¶: Deletes all blocks and services from an instance.

add_block(block, overwrite=False)[source]¶

Add block to instance.

Parameters:	block (Block) – Block instanace to add. overwrite (bool, optional) – If True, configuration will be updated if block is already in Instance. Default is False.
Raises:	`ValueError` – If overwrite is False and block is already in the instance.

add_service(service, overwrite=False, blocks=False)[source]¶

Add service to instance.

Parameters:	service (Service) – Service instanace to add. overwrite (bool, optional) – If True, configuration will be updated if service is already in Instance. Default is False.
Raises:	`ValueError` – If overwrite is False and block is already in the instance.

create_block(name, type, config=None)[source]¶

Create a block in the instance.

Parameters:	name (str) – Name of new block. type (str) – BlockType of new block. config (dict, optional) – Optional configuration of block properties.

create_service(name, type=None, config=None)[source]¶

Create a service in the instance.

Parameters:	name (str) – Name of new service. type (str, optional) – ServiceType of new service. config (dict, optional) – Optional configuration of service.

nio()[source]¶: Returns nio version info.

save()[source]¶: Save all blocks and all services in instance.

Service¶

class pynio.service.Service(name, type='Service', config=None, instance=None)[source]¶

n.io Service

Parameters:	name (str) – Name of new service. type (str, optional) – ServiceType of new service. config (dict, optional) – Optional configuration of service. instance (Instance, optional) – Optional instance to add the service to.

name[source]¶

str

Name of service.

type[source]¶

str

ServiceType of service.

config¶

dict

Configuration of service.

status[source]¶

str

Status of service.

blocks[source]¶: Return a list of blocks used by this service.

command(command, block=None, **request_kwargs)[source]¶

Send a command to the service or to a block in the service.

Parameters:	command (str) – The name of the command. block (str, optional) – The name of the block if commanding a block. request_kwargs – Keyword arguments are passed to http request. Examples: data, timeout (set the request timeout).

connect(blk1, blk2=None)[source]¶

Connect two blocks.

Parameters:	blk1 (Block) – Sends signals to blk2. If blk2 is not specified then blk1 is added to the service with no receivers. blk2 (Block, optional) – Receives signal form blk1.

create_block(name, type, config=None)[source]¶

Create a new block and add it to the service.

Parameters:	name (str) – Name of new block. type (str, optional) – BlockType of new block. config (dict, optional) – Optional configuration of block.

delete()[source]¶: Delete the service from the instance

remove_block(block)[source]¶

Remove a block from service. Does NOT delete the block.

Parameters:	block (Block) – Block to remove from service.

save()[source]¶

PUTs the service config to nio.

Will create a new service if one does not exist by this name. Otherwise it will update the existing service config.

Raises:	`Exception` – If service is not associated with an instance.

start()[source]¶: Starts the nio Service.

stop()[source]¶: Stops the nio Service.

Block¶

class pynio.block.Block(name, type, config=None, instance=None)[source]¶

n.io Service

Blocks are units inside of services. They perform functions on incomming signals and put the signals out.

Parameters:	name (str) – Name of new block. type (str, optional) – BlockType of new block. config (dict, optional) – Optional configuration of block. instance (Instance, optional) – Optional instance to add the block to.