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...
/
docs
/
architecture.rst

architecture.rst 1.7 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 
  1. Lakesuperior Architecture
    2. 

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

  3. 

  4. Lakesuperior is written in Python. It is not excluded that parts of the
    5. 

  5. code may be rewritten in `Cython <http://cython.readthedocs.io/>`__ for
    6. 

  6. performance.
    7. 

  7. 

  8. Multi-Modal Access
    9. 

  9. ------------------
    10. 

  10. 

  11. Lakesuperior services and data are accessible in multiple ways:
    12. 

  12. 

  13. -  Via HTTP. This is the canonical way to interact with LDP resources
    14. 

  14.    and conforms quite closely to the Fedora specs (currently v4).
    15. 

  15. -  Via command line. This method includes long-running admin tasks which
    16. 

  16.    are not available via HTTP.
    17. 

  17. -  Via a Python API. This method allows to use Python scripts to access
    18. 

  18.    the same methods available to the two methods above in a programmatic
    19. 

  19.    way. It is possible to write Python plugins or even to embed
    20. 

  20.    Lakesuperior in a Python application, even without running a web
    21. 

  21.    server.
    22. 

  22. 

  23. Architecture Overview
    24. 

  24. ---------------------
    25. 

  25. 

  26. .. figure:: assets/lakesuperior_arch.png
    27. 

  27.    :alt: Lakesuperior Architecture
    28. 

  28. 

  29.    Lakesuperior Architecture
    30. 

  30. 

  31. The Lakesuperior REST API provides access to the underlying Python API.
    32. 

  32. All REST and CLI operations can be replicated by a Python program
    33. 

  33. accessing this API.
    34. 

  34. 

  35. The main advantage of the Python API is that it makes it very easy to
    36. 

  36. maipulate graph and binary data without the need to serialize or
    37. 

  37. deserialize native data structures. This matters when handling large ETL
    38. 

  38. jobs for example.
    39. 

  39. 

  40. The Python API is divided in three main areas:
    41. 

  41. 

  42. -  Resource API: this API in charge of all the resource CRUD operations and
    43. 

  43.    implements the majority of the Fedora specs.
    44. 

  44. -  Admin API: exposes utility methods, mostly long-running maintenance jobs.
    45. 

  45. -  Query API: provides several facilities for querying repository data.
    46. 

  46. 

  47. 

  48. See :doc:`API documentation<api>` for more details.
    49.