nodes module

class pyobis.nodes.NodesResponse(url, args, mapper, cache=True)[source]: An OBIS Nodes Response Class

Usage

from pyobis import nodes

query = nodes.search(scientificname=["Mola", "Abra"], cache=True, **kwargs)
query.execute()
query.data  # Returns the data
query.api_url  # Returns the API URL

Methods:

pyobis.nodes.search(id=None, cache=True, **kwargs)[source]

Get OBIS nodes records

Parameters:

id – [String] Node UUID.
cache – [bool, optional] Whether to use caching. Defaults to True.

Returns:

A NodesQuery Object

Usage:

from pyobis import nodes
data = nodes.search(id="4bf79a01-65a9-4db6-b37b-18434f26ddfc").execute()

pyobis.nodes.activities(id=None, cache=True, **kwargs)[source]

Get OBIS nodes activities

Parameters:

id – [String] Node UUID.
cache – [bool, optional] Whether to use caching. Defaults to True.

Returns:

A NodesQuery object

Usage:

from pyobis import nodes

# build a query
query = nodes.activities(id="4bf79a01-65a9-4db6-b37b-18434f26ddfc")
query.execute() # execute the query to fetch the data
query.data # get fetched data
query.api_url # check the corresponding OBIS API URL for the query
query.mapper_url # check the corresponding OBIS Mapper URL for the query (if it exists)