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¶: int – Id of graph.

name¶: str – Name of graph.

owner_email¶: str – Email of owner of graph.

is_public¶: int – Accessibility status of graph. Has value 0 if graph is private, 1 if graph is public.

style_json¶: dict – Json representation for graph style.

graph_json¶: dict – Json representation for graph structure.

tags¶: List[str] – Tags of graph.

data¶: dict – Metadata of graph.

node¶: dict – Json representation for nodes of graph.

edge¶: dict – Json representation for edges of graph.

default_layout_id¶: int or None – Id of default layout of graph.

created_at¶: str – Timestamp of graph creation.

updated_at¶: str – Timestamp of graph updation.

url¶: str – URL of graph on GraphSpace.

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¶: int – Id of group.

name¶: str – Name of group.

owner_email¶: str – Email of owner of group.

description¶: str – Description of group.

total_graphs¶: int – Total graphs of group.

total_members¶: int – Total members of group.

invite_code¶: str – Invite code for the group.

created_at¶: str – Timestamp of group creation.

updated_at¶: str – Timestamp of group updation.

url¶: str – URL of group on GraphSpace.

invite_link¶: str – Invite link for joining the group.

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¶: int – Id of layout.

graph_id¶: int – Id of graph to which the layout belongs.

name¶: str – Name of layout.

owner_email¶: str – Email of owner of layout.

is_shared¶: int – Sharing status of layout. Has value 0 if layout is private, 1 if layout is shared.

style_json¶: dict – Json representation for layout style.

positions_json¶: dict – Json representation for layout node positions.

created_at¶: str – Timestamp of layout creation.

updated_at¶: str – Timestamp of layout updation.

url¶: str – URL of graph layout on GraphSpace.

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¶: int – Id of group member.

email¶: str – Email of group member.

created_at¶: str – Timestamp of member creation.

updated_at¶: str – Timestamp of member updation.

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.