Gephi python module

Index

• ToDo list
• Usage
• Documentation
  • Classes
    • Graph
    • Node
    • Edge
    • Color
    • Position
  • Methods

ToDo list

• All classes
• Export to .gexf file
• import from .gexf file

Usage

To use this module you have to write only the import line:

from Gephi import gephi

Documentation

Classes

Graph

Instance

Graph(version, creator, description, mode, default_edge_type)

Method

Permit to add a node in graph node list.

add_node(node)

Return:

• 0: Node has not been added
  • Node already exist
• 1: Node has been added

remove_node(node)

Permit to remove node from graph node list. Return:

• 0: Node has not been removed
  • Node doesn't exist
• 1: Node has been removed

node_exist(node)

Check if exist a node in graph node list. Return:

• false: Node already doesn't exist in graph node list
• true: Node already exist in graph node list

node_id_exist(node)

Check if a node in graph node list has the same id. Return:

• false: Node id already doesn't exist in graph node list
• true: Node id already exist in graph node list

add_edge(edge)

Permit to add an edge to graph edge list. Return:

• 0: Edge has not been added
  • Edge already exist
  • Edge source/target association already exist
  • Doesn't exist an association between edge source and a node id
  • Doesn't exist an association between edge target and a node id
• 1: Edge has been added

remove_edge(edge)

Permit to remove an edge from graph edge list. Return:

• 0: Edge has not been removed
  • Edge doesn't exist
• 1: Edge has been removed

edge_exist(edge)

Check if an edge in graph edge list exist. Return:

• false: Edge already doesn't exist in graph edge list
• true: Edge already exist in graph edge list

edge_association_exist(edge)

Check if an edge in graph edge list has the same source/target association. Return:

• false: Edge id already doesn't exist in graph edge list
• true: Edge id already exist in graph edge list

Node

Instance

Node(id, label, color, position, size, shape)

Method

Return a node info string.

to_string()

Edge

Instance

Edge(id, label, type, source, target, weight)

Method

return an edge info string.

to_string()

Color

Instance

Color(r, g, b)

Method

return a color info string.

to_string()

Position

Instance

Position(x, y, z)

Method

return a position info string.

to_string()

Methods

Permit to create a .gexf file from a Graph to be import into Gephi afterwards.

create_gefx_file(graph, filename)