README.md

cookiecutter-osparc-service

Cookicutter to generate an oSparc compatible service for the oSparc simcore platform.

Status:

---

Currently only for computational services.

Requirements

GNU Make Python3 Python3-venv cookiecutter python package

sudo apt-get update                        
sudo apt-get install -y make python3-venv   # install GNU Make, python3-venv (python3 is usually already installed)
python3 -m venv .venv                       # create a python virtual environment
source .venv/bin/activate                   # activate the python virtual environment
pip install cookiecutter                    # install the cookicutter package

Usage

Generate a new Cookiecutter template layout:

python3 -m venv .venv                                          # create a python virtual environment
source .venv/bin/activate                                      # activate the python virtual environment
cookiecutter gh:ITISFoundation/cookiecutter-osparc-service     # generate a cookie (use cookiecutter --help for additional options)

Development

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

Testing

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

License

This project is licensed under the terms of the MIT License