pennprov

Habitat API

This Python package is automatically generated by the Swagger Codegen project:

• API version: V1.1.0
• Package version: 2.2.1
• Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit https://bitbucket.org/penndb/hab-repo

Requirements.

Python 2.7 and 3.4+; Docker and Docker Compose, if setting up the server in a Docker container.

Installation & Usage

pip install

You can install with pip

pip install pennprov

(you may need to run pip with root permission: sudo pip install pennprov)

Then import the package:

import pennprov 

Getting Started - Client

The following illustrates a simple use of the API to obtain a authentication token and then store and retrieve nodes and edges.

"""Example usage of pennprov client"""

from __future__ import print_function
from pprint import pprint

import pennprov
from pennprov.rest import ApiException


def main():
    """Get a token and store a node"""
    # create instances of the API classes
    configuration = pennprov.configuration.Configuration()
    configuration.host = "http://localhost:8088"
    api_client = pennprov.ApiClient(configuration)    
    auth_api = pennprov.AuthenticationApi(api_client)
    prov_api = pennprov.ProvenanceApi(api_client)
    prov_dm_api = pennprov.ProvDmApi(api_client)
    username = "YOUR_USERNAME"
    credentials = pennprov.UserCredentials(
        "YOUR_PASSWORD")
    graph_name = "my_graph"

    try:
        # One-time initialization of client with a JWT token for
        # authentication.
        web_token = auth_api.get_token_route(username, credentials)
        token = web_token.token
        print("Setting token %s\n" % token)
        configuration.api_key["api_key"] = token

        # Once api_key is set we can call services. For example,
        # store_prov_node
        prov_token_value = "my_prov_token"
        stream = pennprov.IDModel("my_stream.0")
        prov_location = pennprov.ProvLocationModel(
            stream=stream,
            field="my_source",
            position=[1, 2])
        data = [pennprov.FieldModel(
            name="my_boolean_field", type="BOOLEAN", value="true")]
        tuple_with_schema = pennprov.TupleWithSchemaModel(
            schema_name="my_schema", tuple=data, lookup_keys=[])
        body = pennprov.StoreNodeModel(
            prov_specifier=prov_location, tuple_with_schema=tuple_with_schema)
        prov_api.create_provenance_graph(graph_name)
        prov_api.store_provenance_node(graph_name, prov_token_value, body)

        # Retrieve the data from the node
        response = prov_api.get_provenance_data(graph_name, prov_token_value)
        pprint(response)

        # We can also use the ProvDmApi to create PROV data model specific nodes and relations.
        prov_dm_graph = 'my PROV DM graph'
        namespace = 'http://example.com'
        prov_api.create_provenance_graph(prov_dm_graph)
        inputProvId = pennprov.QualifiedName(namespace, 'input1')
        inputEntity = pennprov.NodeModel(type='ENTITY', attributes=[pennprov.Attribute(
            name=pennprov.QualifiedName(namespace, 'stringAttr'), value='paramValue', type='STRING')])
        prov_dm_api.store_node(resource=prov_dm_graph,
                               token=inputProvId, body=inputEntity)

        outputProvId = pennprov.QualifiedName(namespace, 'output1')
        outputEntity = pennprov.NodeModel(type='ENTITY', attributes=[pennprov.Attribute(
            name=pennprov.QualifiedName(namespace, 'longAttr'), value=16, type='LONG')])
        prov_dm_api.store_node(resource=prov_dm_graph,
                               token=outputProvId, body=outputEntity)

        wasDerivedFrom = pennprov.RelationModel(
            type='DERIVATION', subject_id=outputProvId, object_id=inputProvId,
            attributes=[pennprov.Attribute(name=pennprov.QualifiedName(namespace, 'booleanAttr'), value=True, type='BOOLEAN'),
                        pennprov.Attribute(name=pennprov.QualifiedName(namespace, 'anotherStringAttr'), value='attrValue', type='STRING')])
        prov_dm_api.store_relation(resource=prov_dm_graph, body=wasDerivedFrom, label='wasDerivedFrom')

        # And stil use the base ProvenanceApi to retrieve information about the PROV DM graph
        edge = prov_api.get_edges_from(prov_dm_graph, outputProvId)
        pprint(edge)
    except ApiException as api_exception:
        print("Exception when calling server: %s\n" % api_exception)


if __name__ == '__main__':
    main()

Getting Started - Docker

If you want to have a simple Docker container to test the above, do the following.

cd docker-container
docker-compose up

Then (after waiting some time!) open your Web browser to http://localhost:8088 and click on Sign up. Create a new user called YOUR_USERNAME with password YOUR_PASSWORD.

Documentation for API Endpoints

All URIs are relative to http://localhost:8088

Documentation For Models

• Attribute
• FieldModel
• GroupDetails
• IDModel
• LinkInfo
• LinkInstance
• NodeInfo
• NodeInstance
• NodeModel
• OrgDetails
• ProvEdgeModel
• ProvEdgeSetModel
• ProvNodeMapModel
• ProvSpecifierModel
• ProvTokenSetModel
• QualifiedName
• RankInstance
• RelationModel
• ResponseError
• StoreLinkModel
• StoreNodeModel
• SubgraphInstance
• SubgraphTemplate
• TupleWithSchemaModel
• UserCredentials
• UserInfo
• WebToken
• BooleanAttribute
• BooleanFieldModel
• DoubleAttribute
• DoubleFieldModel
• IntAttribute
• IntegerFieldModel
• LongAttribute
• LongFieldModel
• MultiFieldModel
• ProvExpressionModel
• ProvLocationModel
• ProvSpecifierFieldModel
• ProvTokenFieldModel
• ProvTokenModel
• QualifiedNameAttribute
• QualifiedNameFieldModel
• StringAttribute
• StringFieldModel

Documentation For Authorization

jwt

• Type: API key
• API key parameter name: api_key
• Location: HTTP header