Cookiecutter simcore-pyservice

Cookiecutter template for osparc-simcore's python-based services

Requirements

• python >=3.6
  • Install cookiecutter command line: pip install cookiecutter
• docker [optional]
• the internet

Usage

To generate a new cookiecutter template layout just type

 $ cookiecutter gh:itisfoundation/cookiecutter-simcore-pyservice

and answer the questions.

Backed project

Infrastructure:

• osparc-simcore-compatible project skeleton for python services
• service-level makefile (type make help)
• folder with stub code to integrate service in osparc-simcore framework
• Multi-stage Dockerfile with different boot modes and healt-check
• ...

Service Features:

• aiohttp server
• OpenAPI compatible RESTful API
• ...

Then, to work in the backed project, this is the standard wordflow

  $ cd my project
  $ make help

  # Create and activate virtual environment
  $ make venv
  $ source .venv/bin/activate

  # freeze dependencies
  $ make requirements

  $ make

---

Development

$ make help

install – installs all tooling to run and test current cookie-cutter
run – runs cookiecutter into output folder
replay – replays cookiecutter using customized .cookiecutterrc-ignore
test – tests backed cookie
venv – Create the virtual environment into venv folder
requirements – Pip compile requirements.in
help – Display all callable targets
clean – cleans projects directory
clean-force – cleans & removes also venv folder

---

Acknoledgements

This template was built upon ideas/snippets borrowed from already existing great cookiecutters such as gh:ionelmc/cookiecutter-pylibrary, gh:alexkey/cookiecutter-lux-python or gh:mdklatt/cookiecutter-python-app.

License

This project is licensed under the terms of the MIT License