tripal.entity package

Module contents

class tripal.entity.EntityClient(tripalinstance, **requestArgs)

Bases: tripal.client.Client

Manage any type of Tripal entities

add_entity(entity, params={})

Add a new entity to the database

Parameters:
  • entity (str) – Name of the entity
  • params (dict) – Values to populate the entity fields
Return type:

dict
Returns:

Entity information
get_bundles()

Get the list of tripal bundles

Return type:list of dict
Returns:Bundles information
get_entities(entity=None, entity_id=None)

Get entities

Parameters:
  • entity (str) – Name of the entity type (e.g. Organism)
  • entity_id (int) – ID of an entity
Return type:

list of dict
Returns:

Entity information
get_fields(entity)

Get the list of available fields for an entity

Parameters:entity (str) – Name of the entity
Return type:dict
Returns:Fields information
publish(types=[], job_name=None, no_wait=None)

Publish entities (Tripal 3 only)

Parameters:
  • types (list of str) – List of entity types to be published (e.g. Gene mRNA, default: all)
  • job_name (str) – Name of the job
  • no_wait (bool) – Return immediately without waiting for job completion
Return type:

str
Returns:

status