Skip to content

A cookiecutter for integrating services in oSparc simcore platform

License

Notifications You must be signed in to change notification settings

ITISFoundation/cookiecutter-osparc-service

Repository files navigation

cookiecutter-osparc-service

Status: Build Status

Cookiecutter to generate an oSparc compatible service for the oSparc simcore platform. Currently only for computational services supported.

Requirements

  • GNU Make
  • Python3
  • Python3-venv (recommended to work in a virtual environment)
  • cookiecutter
sudo apt-get update
sudo apt-get install -y make python3-venv
python3 -m venv .venv
source .venv/bin/activate
pip install cookiecutter

Usage

Generate a new Cookiecutter template layout:

python3 -m venv .venv
source .venv/bin/activate
cookiecutter gh:ITISFoundation/cookiecutter-osparc-service

Check FAQ

Tutorials and guides

A video tutorial is available:

webinar_preview

Development

git clone https://github.com/ITISFoundation/cookiecutter-osparc-service.git
cd cookiecutter-osparc-service
make devenv
source .venv/bin/activate
make play
make tests

License

This project is licensed under the terms of the MIT License