https://github.com/datajoint/pharus

Pharus is a generic REST API server backend for DataJoint pipelines built on top of flask, datajoint, and pyjwt.
https://github.com/datajoint/pharus

datajoint flask

Last synced: 3 days ago
JSON representation

Pharus is a generic REST API server backend for DataJoint pipelines built on top of flask, datajoint, and pyjwt.

• Host: GitHub
• URL: https://github.com/datajoint/pharus
• Owner: datajoint
• License: mit
• Created: 2020-12-04T04:42:09.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T16:47:25.000Z (5 months ago)
• Last Synced: 2024-04-25T17:54:14.892Z (5 months ago)
• Topics: datajoint, flask
• Language: Python
• Homepage: https://datajoint.com/docs/core/pharus
• Size: 4.16 MB
• Stars: 3
• Watchers: 12
• Forks: 14
• Open Issues: 17
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
User Documentation

==================

``pharus`` is a generic REST API server backend for `DataJoint `_ pipelines built on top of ``flask``, ``datajoint``, and ``pyjwt``.

- `Documentation `_

- `PyPi Package `_

- `Docker Image `_

- `Release `_

- `Source `_

Installation

------------

If you have not done so already, please install the following dependencies.

- `Docker `_

- `Docker Compose `_

Prerequisites

-------------

Download the ``docker-compose-deploy.yaml`` docker environment from the source located `here `_.

Running the API server

----------------------

To start the API server, use the command:

    .. code-block:: bash

        PHARUS_VERSION=0.7.3 docker-compose -f docker-compose-deploy.yaml up -d

To stop the API server, use the command:

    .. code-block:: bash

        PHARUS_VERSION=0.7.3 docker-compose -f docker-compose-deploy.yaml down

References

----------

- DataJoint

  - https://datajoint.io

- DataJoint LabBook (a companion frontend)

  

  - https://github.com/datajoint/datajoint-labbook