Legacy Lakesuperior code.

Stefano Cossu 89b405fe54 Add release notes template. 6 years ago
.github 89b405fe54 Add release notes template. 6 years ago
docker ac4556e54a Development (#41) 6 years ago
docs 7bd26e6f6c Configuration overhaul. 6 years ago
lakesuperior 7bd26e6f6c Configuration overhaul. 6 years ago
tests cc754e17d5 Support PATCH on root node. Fixes #45. 6 years ago
.gitignore 7bd26e6f6c Configuration overhaul. 6 years ago
.travis.yml 05f904ddb4 Limit Travis deployment to Python 3.5. 6 years ago
Dockerfile ac4556e54a Development (#41) 6 years ago
LICENSE 2fdc1b902e Initial commit: some boilerplate borrowed from Combine, basic folder structure and documentation. 6 years ago
MANIFEST.in 7bd26e6f6c Configuration overhaul. 6 years ago
README.rst 2501c3c458 Bump version to a11; refine documentation. 6 years ago
code_of_conduct.md 84e744b073 Doc update. 6 years ago
conftest.py 7bd26e6f6c Configuration overhaul. 6 years ago
docker-compose.yml 82d8112911 Add reference to automated build (#28) 6 years ago
requirements.txt b73053368d Prepare for alpha9 6 years ago
requirements_rtd.txt 6ee37a3ed3 Add requirements file for RTD. 6 years ago
setup.cfg f0248dee52 Package software. 6 years ago
setup.py 7bd26e6f6c Configuration overhaul. 6 years ago

README.rst

LAKEsuperior
============

|build status| |docs|

LAKEsuperior is an alternative `Fedora
Repository `__ implementation.

Fedora is a mature repository software system historically adopted by
major cultural heritage institutions. It exposes an
`LDP `__ endpoint to manage
any type of binary files and their metadata in Linked Data format.

Guiding Principles
------------------

LAKEsuperior aims at being an uncomplicated, efficient Fedora 4
implementation.

Its main goals are:

- **Reliability:** Based on solid technologies with stability in mind.
- **Efficiency:** Small memory and CPU footprint, high scalability.
- **Ease of management:** Tools to perform monitoring and maintenance
included.
- **Simplicity of design:** Straight-forward architecture, robustness
over features.

Key features
------------

- Drop-in replacement for Fedora4
- Very stable persistence layer based on
`LMDB `__ and filesystem. Fully
ACID-compliant writes guarantee consistency of data.
- Term-based search (*planned*) and SPARQL Query API + UI
- No performance penalty for storing many resources under the same
container
- Extensible provenance metadata tracking
- Multi-modal access: HTTP (REST), command line interface and native Python
API.
- Fits in a pocket: you can carry 50M triples in an 8Gb memory stick.

Installation & Documentation
----------------------------

With Docker::

git clone https://github.com/scossu/lakesuperior.git
cd lakesuperior
docker-compose up

With pip (assuming you are familiar with it)::

pip install lakesuperior

The full, current documentation is maintained in `Read The Docs
`__. Please refer to that for more info,
including installation instructions.

.. |build status| image:: http://img.shields.io/travis/scossu/lakesuperior/master.svg?style=flat
:alt: Build Status
:target: https://travis-ci.org/username/repo

.. |docs| image:: https://readthedocs.org/projects/lakesuperior/badge/
:alt: Documentation Status
:target: https://lakesuperior.readthedocs.io/en/latest/?badge=latest