Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kakwa/pygraph_redis
Simple python library to manipulate directed graphs in redis
https://github.com/kakwa/pygraph_redis
directed-graph graph python redis
Last synced: about 1 month ago
JSON representation
Simple python library to manipulate directed graphs in redis
- Host: GitHub
- URL: https://github.com/kakwa/pygraph_redis
- Owner: kakwa
- License: mit
- Created: 2013-02-26T19:55:33.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-05-24T19:30:32.000Z (over 7 years ago)
- Last Synced: 2024-11-14T20:21:26.528Z (about 2 months ago)
- Topics: directed-graph, graph, python, redis
- Language: Python
- Homepage:
- Size: 550 KB
- Stars: 24
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
pygraph_redis
==============
Simple python library to manipulate directed graphs in redis
.. image:: https://secure.travis-ci.org/kakwa/pygraph_redis.png?branch=master
:target: http://travis-ci.org/kakwa/pygraph_redis
:alt: Travis CI
.. image:: https://img.shields.io/pypi/v/pygraph_redis.svg
:target: https://pypi.python.org/pypi/pygraph_redis
:alt: PyPI version
.. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/kakwa/pygraph_redis
:target: https://gitter.im/kakwa/pygraph_redis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. image:: https://coveralls.io/repos/kakwa/pygraph_redis/badge.svg
:target: https://coveralls.io/r/kakwa/pygraph_redis
License
=======
pygraph_redis is released under the MIT Public License
Description
===========
pygraph_redis is a simple library to manipulate directed graphs inside a redis database.
In this library, a graph is a bunch of nodes, each node knows its predecessors
and its successors. A node can store some attributs (strings or sets of strings).
Dependancies
============
pygraph_redis relies on `redis `_ and `redis-py `_.
For atomicity of transaction, it requires lua scripting support (redis-py >= 2.7.0 and redis >= 2.6.0), but it provides a legacy mode, without atomicity for older redis and redis-py.
Write atomicity
===============
With proper versions, pygraph\_redis provides the atomicity of transaction when adding or removing a node.
Installation
============
to install:
.. sourcecode:: bash
$ python setup.py install
or
$ pip install pygraph_redis
How to use
==========
First you need a redis database, it's up to you to install it.
The library itself is quite simple:
Cheat Sheet
-----------
.. sourcecode:: python
# initialization
# arg1 | arg2 | arg3
#--------------------------------------------
# redis connexion | graph_name | logger
# redis obj | unicode | logger obj
mygraph1 = Directed_graph(r_server, u'mygraph1', logger)
#optional args:
# arg4 | arg5
#-----------------------
# separator | has_root
# unicode | bool
mygraph1 = Directed_graph(r_server,
u'mygraph1', logger, u'mysep', True)
)
.. sourcecode:: python
# create or add elements to a node
# arg1 | arg2 | arg3 | arg4
#---------------------------------------------------------------------------
# node name | successors | predecessors | attributs
# unicode | unicode list | unicode list | dictionnary of unicode
# | | | or set of unicode (key: unicode)
mygraph1.write_on_node(u'm1',
[u's2'],
[u'p1'],
{u'a3': set([u'69']), u'a2': u'42'}
)
.. sourcecode:: python
# delete elements from a node
# arg1 | arg2 | arg3 | arg4
#----------------------------------------------------------
# node name | successors | predecessors | attributs names
# unicode | unicode list | unicode list | list of unicode
mygraph1.write_off_node(u'm1', [u's2'], [u'p1'], [u'attr3', u'attr2']
.. sourcecode:: python
# delete a node
# arg1
#--------------
# node name
# unicode
mygraph1.remove_node(u'm1')
.. sourcecode:: python
# get attributs list
# arg1
#--------------
# node name
# unicode
mygraph1.get_attributs_list(u'm1')
.. sourcecode:: python
# get an attribut
# arg1 | arg2
#--------------|--------------
# node name | attribut name
# unicode | unicode
mygraph1.get_attribut(u'm1', u'a2')
.. sourcecode:: python
# get an attribut length
# arg1 | arg2
#--------------|--------------
# node name | attribut name
# unicode | unicode
mygraph1.get_attribut_len(u'm1', u'a2')
.. sourcecode:: python
# get successors
# arg1
#--------------
# node name
# unicode
mygraph1.get_successors(u'm1')
.. sourcecode:: python
# get predecessors
# arg1
#--------------
# node name
# unicode
mygraph1.get_predecessors(u'm1')
Initialization
--------------
Create an instance of "Directed\_graph":
.. sourcecode:: python
#importing directed_graph
from pygraph_redis.directed_graph import Directed_graph
import redis
#creating a basic logger
import logging
logging.basicConfig(format = u'%(message)s')
logger = logging.getLogger(u'redis')
logger.parent.setLevel(logging.DEBUG)
#creating the redis connexion
r_server = redis.Redis("localhost")
#creating the graph object
mygraph1 = Directed_graph(r_server, u'mygraph1', logger)
#creating the graph object with a different separator
mygraph2 = Directed_graph(r_server, u'mygraph2', logger, separator = u'mysep')
#creating the graph object with a "root" (improper name, I know)
mygraph2 = Directed_graph(r_server, u'mygraph2', logger, has_root = True)
#"has_root = True" ensures that every node has a predecessor
#if enabled, a node has at least root as a predecessor,
#but if it has any other predecessor it doesn't have root as predecessor
Node manipulation
-----------------
Node creation:
.. sourcecode:: python
#add node 'm1' to 'mygraph1' with:
#successors: 's1' and 's2'
#predecessors: 'p1' and 'p2'
#attributs:
# * 'attr1': set([u'51',u'69'])
# * 'attr2': '42'
mygraph1.write_on_node(u'm1',
[u's1', u's2'],
[u'p1', u'p2'],
{u'attr1': set([u'51', u'69']), u'attr2': u'42'}
)
About `successors` and `predecessors`, if node was already declared as a predecessor of one
of its successors, it's not necessary to add this successor in node successors set.
Same with `predecessors`.
example:
.. sourcecode:: python
mygraph1.write_on_node(u'pred',
[u'succ'],
[],
{}
)
.. sourcecode:: python
mygraph1.write_on_node(u'succ',
[],
[],
{}
)
Gives the same result that:
.. sourcecode:: python
mygraph1.write_on_node(u'pred',
[u'succ'],
[],
{}
)
.. sourcecode:: python
mygraph1.write_on_node(u'succ',
[],
[u'pred'],
{}
)
Node edition:
.. sourcecode:: python
#add new elements or edit existing elements of a node
#it's exactly the same function as before
mygraph1.write_on_node(u'm1',
[u's4'],
[],
{u'attr3': set([u'16', u'32', u'64']), u'attr2': u'5150'}
)
#remove some elements of a node (successors, predecessors, attributs)
mygraph1.write_off_node(u"m1", [u"s1"], [u"p2"],[u'attr2'])
#completely delete a node
mygraph1.remove_node(u'm1')
Node attributs manipulation
---------------------------
To manipulate the attributs of a node:
.. sourcecode:: python
#create the node 'm2'
mygraph1.write_on_node(u'm2',
[u's1', u's2'],
[u'p1', u'p2'],
{u'attr1': set([u'51', u'69']), u'attr2': u'42'}
)
#get the set of attribut names
set_of_attributs = mygraph1.get_attributs_list(u'm2')
print set_of_attributs
#get a specific attribut
attr2 = mygraph1.get_attribut(u'm2', u'attr2')
print attr2
#get a specific attribut length
# 1 if it's a string
# cardinal of set if it's a set
# 0 if attribut doesn't exists
attr2 = mygraph1.get_attribut_len(u'm2', u'attr2')
print attr2
Graph navigation
----------------
To navigate inside the graph, you have two functions:
.. sourcecode:: python
#get the predecessors of 'm2'
predecessors = mygraph1.get_predecessors(u'm2')
print predecessors
#get the successors of 'm2'
successors = mygraph1.get_successors(u'm2')
if you have the `has_root` flag enable:
.. sourcecode:: python
#get the "root" name
root = mygraph1.get_root_name()
print root
#get the successors of 'root'
successors = mygraph1.get_successors(root)
print successors
About the redis keys
--------------------
Redis key format:
.. sourcecode:: none
[]*
: name of the graph
: the key fields separator
(this string should not be in node_name or variable_name,
otherwise, there is a redis key collision possibility)
: name of the node
: name of the variable
[]: optional extension
To avoid key collision, you must carefully choose the key separator,
it must not be included in any node name or node attribut name (possible redis key collision).
About the logs
--------------
This library provides a lot of logs, mainly debug, some info (ex: legacy modes), some warning (ex: possible key collision)
.. image:: https://d2weczhvl823v0.cloudfront.net/kakwa/pygraph_redis/trend.png
:alt: Bitdeli badge
:target: https://bitdeli.com/free