Library for graph-like storage in postgresql using sqlalchemy
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
doc
psqlgraph
test
.gitignore Configured tests for psql2neo4j Mar 24, 2015
.travis.yml
README.md
setup.py

README.md

Build Status

Overview

The psqlgraph library is a layer on top of SQLAlchemy's ORM layer that attemps to capitalize on the benefits of SQL while utilizing Postgresql's JSONB support for SQL-less flexibility. Psqlgraph allows you to interact with your data graphically by defining Node and Edge models to maintain flexible many-to-many relationships.

Usage

For usage documentation please see /doc/build/html.

Installation

Dependencies

Before continuing you must have the following programs installed:

The psqlgraph library requires the following pip dependencies

Project Dependencies

Project dependencies are managed using PIP

Building Documentation

Documentation is built using Sphinx.

❯ cd doc
❯ make html
sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.2.3
     ...
dumping object inventory... done
build succeeded.

Build finished. The HTML pages are in build/html.

Test Setup

Running the setup script will:

  1. Setup the test postgres tables
❯ python psqlgraph/setup_psql_graph.py
Setting up test database
Dropping old test data
Creating tables in test database

Contributing

Read how to contribute here

Tests

Running the setup script will test the library against a local postgres installation

❯  pip install pytest
❯  cd test
❯  py.test -v