Skip to main content

Full-Stack Data/Knowledge Management with Neo4j

Project description

Brain Annex - a full technology stack on top of GRAPH DATABASES

This is a mono-repository of:

  1. The "Brain Annex" python library
  2. The "Brain Annex" web app (backend and frontend)

Graph databases currently supported:

  1. Neo4j, version 4.4 (the final release of major version 4)
  2. Neo4j, version 5.26 (the final release of major version 5)
  3. We expect to later support others, possibly Memgraph and AWS Neptune

Do you only care about the python library?

Simply:

  • pip install brainannex-neo4jv4
    or
  • pip install brainannex-neo4jv5
    (based on which major version of Neo4j you use.)
    Nothing else to do!

Then use it with imports such as:
from brainannex import NeoAccess
(notice that we are just saying brainannex here, NOT the full install name!)

IMPORTANT for installing the web app - to switch between supported databases:

  1. Must change the database driver, in the first line of requirements.txt
  2. Must comment/uncomment the appropriate version lines in the brainannex/__init__.py file, for the InterGraph module, which is database-specific.

Website: https://BrainAnnex.org

Change Log

Brain Annex's Technology Stack (Overview)

BRAIN ANNEX PYTON LIBRARY

From lower to higher levels:

  • InterGraph library (low-level, database-specific layer)

  • NeoAccess library (python interface offering many services)

  • NeoSchema library (optional Schema layer)

  • plus several other specialized high-level libraries


What is a "Schema layer"?

A schema layer harmoniously brings together the best of the flexibility ("anything goes!") of graph databases, and the "law and order" aspect of relational databases!


BRAIN ANNEX WEB APP

  • Python/Flask (for web API, and web app pages)

  • Vue2.js

EXAMPLE of use case : Multimedia Knowledge Representation and Management

Motivation and overview

What are Neo4j/Graph Databases, and why do they matter?

If you're new, here's a gentle brief intro.

Brain Annex's Technology Stack (Details)

Brain Annex may be used as a standalone web app, or used to power other web apps.
The libraries that are the bottom layers may also be used independently.

Brain Annex Technology Stack

How to set up and use Brain Annex WEB APP

(Note: if you only care about the python library, just pip install it! This section doesn't apply to you!)

The underlying graph database and the Brain Annex web app may be installed either locally or on a remote server.

The database and web app may reside on the same or different machines.

SETUP

INSTRUCTIONS

EXAMPLES of Schemas available for import

(For instructions on how to import the Schemas, see the setup page, above)

EXAMPLE 1 - the available default Multimedia Content Management System

The ROOT node for the Categories is shown in blue at the top.

Minimal_Schema_plus_ROOT_category.png


EXAMPLE 2 - same as example 1, but with sample extra Classes (representative of user-added schema)

The diagram below is split in 2 parts, for readability.

"chem" is an example of a custom Class.

Classes and Properties in Brain Annex - Non-record types

The following second half of the diagram shows the remainder of the Schema, detailing Classes that are instances of the "Records" Class. Most of the items in this diagram are examples of typical user-added schema:

Classes and Properties in Brain Annex - Record types

Major components

  • NeoAccess : a library to connect to Neo4j with python. It provides many services. Link

  • NeoSchema : a higher-level schema-based library on top of NeoAccess. Link
    Article explaining this layer

  • CK Editor : open-source JavaScript library to implement an online HTML Editor.
    Website. (Note: Brain Annex uses version 4 of the CK Editor)

  • API : the endpoints appear in this file

  • Web pages : the pages generated by Brain Annex are listed in this routing file

  • Navigation bar : Brain Annex can be used either as a standalone web app, or integrated with another site.
    The navigation is implemented in this package

Project website: https://BrainAnnex.org

The lead author of Brain Annex can be reached on LinkedIn

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brainannex_neo4jv5-5.0rc5.tar.gz (142.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

brainannex_neo4jv5-5.0rc5-py3-none-any.whl (151.0 kB view details)

Uploaded Python 3

File details

Details for the file brainannex_neo4jv5-5.0rc5.tar.gz.

File metadata

  • Download URL: brainannex_neo4jv5-5.0rc5.tar.gz
  • Upload date:
  • Size: 142.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for brainannex_neo4jv5-5.0rc5.tar.gz
Algorithm Hash digest
SHA256 adda2aa6443b233c0de05b6d5f6d9051872c6d2b89f733527692d89b098f103a
MD5 c307d164d3500bfdd879ea837df18924
BLAKE2b-256 62d443fe0625414f89402efd2ea789170dd42d73b79a28adcefa0fc7186bfda6

See more details on using hashes here.

File details

Details for the file brainannex_neo4jv5-5.0rc5-py3-none-any.whl.

File metadata

File hashes

Hashes for brainannex_neo4jv5-5.0rc5-py3-none-any.whl
Algorithm Hash digest
SHA256 213bd60deda1e90addc1f3c0b9af793a86ba73d0e0272021f15cc2b33cd4d3f5
MD5 31a9c172efd6f324baa7b2bb677ef098
BLAKE2b-256 b5fbcd6e47580edb1c1e6a7cfec2b7cc3be7524860461829cd601fa20f641e44

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page