Brainiak

Brainiak is a Linked Data RESTful API to provide transparent access to SPARQL endpoints.

This project was created by Globo.com's engineers to enhace its semantic platform. We are releasing this as an open-source project in order to give something back to the software community.

Learn more about Brainiak at this slideshare presentation.

DISCLAIMER

The project is released as it is. This means you might have to tweak it, in order to meet your purpose. People can contribute to turn this project more adoption-friendly outside its original context of creation and use.

For this purpose, use the forum https://groups.google.com/forum/#!forum/brainiak_api_users to discuss ideas and ask questions.

We use the twitter @brainiak_api's to broadcast information about the project and related subjects.

And we also have a facebbok page at https://www.facebook.com/brainiakapi.

Motivation

The following topics motivated the development of Brainiak:

• Lower the barrier to use semantic technlogies
• Encapsulate the access to triple stores compatible with RDF/TURTLE and SPARQL (e.g. OpenLink Virtuoso, Sesame, AllegroGraph, Ontotext OWLIM)
• Enhance data management to triple stores
• Provide a unique and coherent interface to other database backends, including non triple stores (e.g.: ElasticSearch).

Documentation

Internally at Globo.com, the docs are available at http://brainiak.semantica.globoi.com/docs/

The documentation source is available at brainiak_api/docs directory. It was developed using Sphinx and Program output plugin.

The documentation build is also temporarily available at brainiak_api/docs.

Running

Brainiak is developed using Python.

The requirements for currently running Brainiak are:

• Python packages (detailed at requirements.txt)
• Triplestore: Virtuoso 6
• Search engine: ElasticSearch 0.90.12
• Event bus: ActiveMQ 5.8.0
• Cache Redis (optional)

Currently Brainiak is run in production using CentOS, but the deployment scripts are of internal use at Globo.com and won't be released open-source.

Fedora

There are complete setup instructions and scripts for Fedora 20, at: https://github.com/globoi/brainiak_api/tree/master/setup/fedora

MacOS

Setup scripts are being added to: https://github.com/globoi/brainiak_api/tree/master/setup/macosx

General instructions

It can be installed using virtualenvwrapper: :

# Install virtualenv / virtualenvwraper, in case you didn't yet:
sudo pip install virtualenv
sudo pip install virtualenvwrapper
source `which virtualenvwrapper.sh`

# Then, just use it:
mkvirtualenv brainiak
workon brainiak
make install

Or using super-user powers: :

sudo make install

After virtualenv is ready (run in development mode): :

make run

By default, brainiak will be available at: http://localhost:5100/

Testing

There are two categories of tests in Brainiak: - Unit (python-only) - Integration (need other services to be up, e.g Virtuoso)

Run unit tests using: :

make unit

Run integration tests using: :

make integration

To run all tests, and check how much of the code is covered with tests: :

make test

We expect contributions to have related tests, so we can keep up test code coverage to more than 90%.

License

Brainiak is GNU GPL 2: :

< Brainiak: Linked Data RESTful API >
Copyright (C) 2013 - Globo.com

Brainiak is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 2 of the License.

Brainiak is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Brainiak. If not, see <http://www.gnu.org/licenses/>.