Home Explore Help
Register Sign In
scossu
/
lakesuperior_legacy
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: acca1a1a53
Branches Tags
lakesuperior...
/
README.rst

README.rst 2.5 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576 
  1. Lakesuperior
    2. 

  2. ============
    3. 

  3. 

  4. |build status| |docs| |pypi| |codecov|
    5. 

  5. 

  6. Lakesuperior is an alternative `Fedora
    7. 

  7. Repository <http://fedorarepository.org>`__ implementation.
    8. 

  8. 

  9. Fedora is a mature repository software system historically adopted by
    10. 

  10. major cultural heritage institutions. It exposes an
    11. 

  11. `LDP <https://www.w3.org/TR/ldp-primer/>`__ endpoint to manage
    12. 

  12. any type of binary files and their metadata in Linked Data format.
    13. 

  13. 

  14. Guiding Principles
    15. 

  15. ------------------
    16. 

  16. 

  17. Lakesuperior aims at being an uncomplicated, efficient Fedora 4
    18. 

  18. implementation.
    19. 

  19. 

  20. Its main goals are:
    21. 

  21. 

  22. -  **Reliability:** Based on solid technologies with stability in mind.
    23. 

  23. -  **Efficiency:** Small memory and CPU footprint, high scalability.
    24. 

  24. -  **Ease of management:** Tools to perform monitoring and maintenance
    25. 

  25.    included.
    26. 

  26. -  **Simplicity of design:** Straight-forward architecture, robustness
    27. 

  27.    over features.
    28. 

  28. 

  29. Key features
    30. 

  30. ------------
    31. 

  31. 

  32. -  Drop-in replacement for Fedora4
    33. 

  33. -  Very stable persistence layer based on
    34. 

  34.    `LMDB <https://symas.com/lmdb/>`__ and filesystem. Fully
    35. 

  35.    ACID-compliant writes guarantee consistency of data.
    36. 

  36. -  Term-based search and SPARQL Query API + UI
    37. 

  37. -  No performance penalty for storing many resources under the same
    38. 

  38.    container, or having one resource link to many URIs
    39. 

  39. -  Extensible provenance metadata tracking
    40. 

  40. -  Multi-modal access: HTTP (REST), command line interface and native Python
    41. 

  41.    API.
    42. 

  42. -  Fits in a pocket: you can carry 50M triples in an 8Gb memory stick.
    43. 

  43. 

  44. Installation & Documentation
    45. 

  45. ----------------------------
    46. 

  46. 

  47. With Docker::
    48. 

  48. 

  49.     git clone https://github.com/scossu/lakesuperior.git
    50. 

  50.     cd lakesuperior
    51. 

  51.     docker-compose up
    52. 

  52. 

  53. With pip (assuming you are familiar with it)::
    54. 

  54. 

  55.     pip install lakesuperior
    56. 

  56. 

  57. The full, current documentation is maintained in `Read The Docs
    58. 

  58. <http://lakesuperior.readthedocs.io/>`__. Please refer to that for more info,
    59. 

  59. including installation instructions.
    60. 

  60. 

  61. .. |build status| image:: http://img.shields.io/travis/scossu/lakesuperior/master.svg?style=flat
    62. 

  62.    :alt: Build Status
    63. 

  63.    :target: https://travis-ci.org/username/repo
    64. 

  64. 

  65. .. |docs| image:: https://readthedocs.org/projects/lakesuperior/badge/
    66. 

  66.     :alt: Documentation Status
    67. 

  67.     :target: https://lakesuperior.readthedocs.io/en/latest/?badge=latest
    68. 

  68. 

  69. .. |pypi| image:: https://badge.fury.io/py/lakesuperior.svg
    70. 

  70.     :alt: PyPI Package
    71. 

  71.     :target: https://badge.fury.io/py/lakesuperior
    72. 

  72. 

  73. .. |codecov| image:: https://codecov.io/gh/scossu/lakesuperior/branch/master/graph/badge.svg
    74. 

  74.   :alt: Code coverage
    75. 

  75.   :target: https://codecov.io/gh/scossu/lakesuperior
    76. 

  76.