api.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. API Documentation
  2. ==================
  3. Main Interface
  4. --------------
  5. The Lakesuperior API modules of most interest for a client are:
  6. - :mod:`lakesuperior.api.resource`
  7. - :mod:`lakesupeiror.api.query`
  8. - :mod:`lakesuperior.api.admin`
  9. Lower-Level Interfaces
  10. ----------------------
  11. :mod:`lakesuperior.model.ldp` handles the concepts of LDP resources,
  12. containers, binaries, etc.
  13. :mod:`lakesuperior.store.ldp_rs.rsrc_centric_layout` handles the "layout" of
  14. LDP resources as named graphs in a triplestore. It is possible (currently not
  15. without changes to the core libraries) to devise a different layout for e.g. a
  16. more sparse, or richer, data model.
  17. Similarly, :mod:`lakesuperior.store.ldp_nr.base_non_rdf_layout` offers an
  18. interface to handle the layout of LDPR resources. Currently only one
  19. implementation is available but it is also possible to create a new module to
  20. e.g. handle files in an S3 bucket, a Cassandra database, or create Bagit or
  21. OCFL file structures, and configure Lakesuperior to use one, or more, of those
  22. persistence methods.
  23. Deep Tissue
  24. -----------
  25. Some of the Cython libraries in :mod:`lakesuperior.model.structures`,
  26. :mod:`lakesuperior.model.rdf`, and :mod:`lakesuperior.store` have
  27. Python-accessible methods for high-performance manipulation. The
  28. :py:class:`lakesuperior.model.rdf.graph.Graph` class is an example of that.
  29. Full API Documentation
  30. ----------------------
  31. .. toctree::
  32. :caption: Modules
  33. apidoc/modules