graphspace_python.api.obj package

Submodules

graphspace_python.api.obj.api_response module

class graphspace_python.api.obj.api_response.APIResponse(response_type, response)[source]

Bases: graphspace_python.api.obj.response_object.ResponseObject

APIResponse class.

Encapsulates the response from API calls.

graphspace_python.api.obj.graph module

class graphspace_python.api.obj.graph.Graph(response)[source]

Bases: graphspace_python.api.obj.response_object.ResponseObject, graphspace_python.graphs.classes.gsgraph.GSGraph

Graph object class.

Encapsulates details of a graph received in response.

id

Id of graph.

Type:int
name

Name of graph.

Type:str
owner_email

Email of owner of graph.

Type:str
is_public

Accessibility status of graph. Has value 0 if graph is private, 1 if graph is public.

Type:int
style_json

Json representation for graph style.

Type:dict
graph_json

Json representation for graph structure.

Type:dict
tags

Tags of graph.

Type:List[str]
data

Metadata of graph.

Type:dict
node

Json representation for nodes of graph.

Type:dict
edge

Json representation for edges of graph.

Type:dict
default_layout_id

Id of default layout of graph.

Type:int or None
created_at

Timestamp of graph creation.

Type:str
updated_at

Timestamp of graph updation.

Type:str
url

URL of graph on GraphSpace.

Type:str

graphspace_python.api.obj.group module

class graphspace_python.api.obj.group.Group(response)[source]

Bases: graphspace_python.api.obj.response_object.ResponseObject, graphspace_python.graphs.classes.gsgroup.GSGroup

Group object class.

Encapsulates details of a group received in response.

id

Id of group.

Type:int
name

Name of group.

Type:str
owner_email

Email of owner of group.

Type:str
description

Description of group.

Type:str
total_graphs

Total graphs of group.

Type:int
total_members

Total members of group.

Type:int
invite_code

Invite code for the group.

Type:str
created_at

Timestamp of group creation.

Type:str
updated_at

Timestamp of group updation.

Type:str
url

URL of group on GraphSpace.

Type:str

Invite link for joining the group.

Type:str

graphspace_python.api.obj.layout module

class graphspace_python.api.obj.layout.Layout(response)[source]

Bases: graphspace_python.api.obj.response_object.ResponseObject, graphspace_python.graphs.classes.gslayout.GSLayout

Layout object class.

Encapsulates details of a layout received in response.

id

Id of layout.

Type:int
graph_id

Id of graph to which the layout belongs.

Type:int
name

Name of layout.

Type:str
owner_email

Email of owner of layout.

Type:str
is_shared

Sharing status of layout. Has value 0 if layout is private, 1 if layout is shared.

Type:int
style_json

Json representation for layout style.

Type:dict
positions_json

Json representation for layout node positions.

Type:dict
created_at

Timestamp of layout creation.

Type:str
updated_at

Timestamp of layout updation.

Type:str
url

URL of graph layout on GraphSpace.

Type:str

graphspace_python.api.obj.member module

class graphspace_python.api.obj.member.Member(response)[source]

Bases: graphspace_python.api.obj.response_object.ResponseObject

Member object class.

Encapsulates details of a group member received in response.

id

Id of group member.

Type:int
email

Email of group member.

Type:str
created_at

Timestamp of member creation.

Type:str
updated_at

Timestamp of member updation.

Type:str

graphspace_python.api.obj.response_object module

class graphspace_python.api.obj.response_object.ResponseObject(response)[source]

Bases: object

ResponseObject class.

Abstract class that provides methods to parse an entity received in response into an object.

Module contents