API Documentation

Main Interface

The Lakesuperior API modules of most interest for a client are:

• lakesuperior.api.resource
• lakesupeiror.api.query
• lakesuperior.api.admin

Lower-Level Interfaces

lakesuperior.model.ldp handles the concepts of LDP resources, containers, binaries, etc.

lakesuperior.store.ldp_rs.rsrc_centric_layout handles the “layout” of LDP resources as named graphs in a triplestore. It is possible (currently not without changes to the core libraries) to devise a different layout for e.g. a more sparse, or richer, data model.

Similarly, lakesuperior.store.ldp_nr.base_non_rdf_layout offers an interface to handle the layout of LDPR resources. Currently only one implementation is available but it is also possible to create a new module to e.g. handle files in an S3 bucket, a Cassandra database, or create Bagit or OCFL file structures, and configure Lakesuperior to use one, or more, of those persistence methods.

Deep Tissue

Some of the Cython libraries in lakesuperior.model.structures, lakesuperior.model.rdf, and lakesuperior.store have Python-accessible methods for high-performance manipulation. The lakesuperior.model.rdf.graph.Graph class is an example of that.

Full API Documentation

Modules

• lakesuperior
  • lakesuperior package
    • Subpackages
      • lakesuperior.api package
        • Submodules
        • lakesuperior.api.admin module
        • lakesuperior.api.query module
        • lakesuperior.api.resource module
      • lakesuperior.cy_include package
      • lakesuperior.dictionaries package
        • Submodules
        • lakesuperior.dictionaries.namespaces module
        • lakesuperior.dictionaries.srv_mgd_terms module
      • lakesuperior.endpoints package
        • Submodules
        • lakesuperior.endpoints.admin module
        • lakesuperior.endpoints.ldp module
        • lakesuperior.endpoints.main module
        • lakesuperior.endpoints.query module
      • lakesuperior.messaging package
        • Submodules
        • lakesuperior.messaging.formatters module
        • lakesuperior.messaging.handlers module
        • lakesuperior.messaging.messenger module
      • lakesuperior.model package
        • Subpackages
          • lakesuperior.model.rdf package
            • Submodules
            • lakesuperior.model.rdf.graph module
            • lakesuperior.model.rdf.term module
            • lakesuperior.model.rdf.triple module
          • lakesuperior.model.structures package
            • Submodules
            • lakesuperior.model.structures.hash module
            • lakesuperior.model.structures.keyset module
        • Submodules
        • lakesuperior.model.base module
        • lakesuperior.model.callbacks module
      • lakesuperior.store package
        • Subpackages
          • lakesuperior.store.ldp_nr package
            • Submodules
            • lakesuperior.store.ldp_nr.base_non_rdf_layout module
            • lakesuperior.store.ldp_nr.default_layout module
          • lakesuperior.store.ldp_rs package
            • Submodules
            • lakesuperior.store.ldp_rs.lmdb_store module
            • lakesuperior.store.ldp_rs.lmdb_triplestore module
            • lakesuperior.store.ldp_rs.rsrc_centric_layout module
        • Submodules
        • lakesuperior.store.base_lmdb_store module
        • lakesuperior.store.metadata_store module
      • lakesuperior.util package
        • Submodules
        • lakesuperior.util.benchmark module
        • lakesuperior.util.generators module
        • lakesuperior.util.ingest_random_image module
        • lakesuperior.util.locustfile module
        • lakesuperior.util.toolbox module
      • lakesuperior.wsgi package
    • Submodules
    • lakesuperior.app module
    • lakesuperior.config_parser module
    • lakesuperior.env_setup module
    • lakesuperior.exceptions module
    • lakesuperior.globals module
    • lakesuperior.lsup_admin module
    • lakesuperior.migrator module
    • lakesuperior.profiler module
    • lakesuperior.server module