README.rst 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. ##########
  2. SpEndPoint
  3. ##########
  4. Creates a SPARQL endpoint supporting custom services.
  5. The default access point is at `http://127.0.0.1:8000`.
  6. This endpoint can be configured in the `configuration.toml <data/configuration.toml>`_ file.
  7. The docker image created uses uvicorn the host the application at `0.0.0.0:80`. Feel free to map this to any port of your liking.
  8. We currently support 3 services out of the box:
  9. .. code-block::
  10. dtf:outlier
  11. dtf:example
  12. dtf:conversion
  13. The outlier service relies on `another endpoint <https://msdl.uantwerpen.be/git/lucasalbertins/DTDesign/src/main/tools/typeOperations>`_ which needs to be set up and accessible.
  14. Installation
  15. ------------
  16. ..
  17. .. code-block:: shell
  18. pip install spendpoint
  19. or
  20. .. code-block:: shell
  21. pip install --index-url https://pip:glpat-m8mNfhxZAUnWvy7rLS1x@git.rys.one/api/v4/projects/262/packages/pypi/simple --no-deps spendpoint
  22. Configuration
  23. -------------
  24. A configuration file at `configuration.toml <data/configuration.toml>`_ holds all user configurable data.
  25. You can set the `host` and `port` the server will listen on.
  26. A more advanced use is to import extra services.
  27. These services need to be defined in the `service.py` file as well.