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.

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

Before continuing you must have the following programs installed:

• Python 2.7+
• Postgresql 9.4

The psqlgraph library requires the following pip dependencies

• SQLAlchemy
• Psycopg2

Project dependencies are managed using PIP

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.

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

Read how to contribute here

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

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