Is245/rest features (ITISFoundation#2)

Updated features from latest versions of osparc-simcore services

-  new files skeleton
  - added ``extra`` folder with  code parts to integrate in osparc-simcore (e.g. api/specs or docker-compose)
  - local makefile, bumpversion, and license
-  cli
-  REST API subsystem
-  Dockerfile

closes to ITISFoundation/osparc-simcore#245

Author: pcrespov

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# Order is important. The last matching pattern has the most precedence.
+
+# files and folders recursively
+/                  @pcrespov
+
+# any change in travis
+/.travis.yml     @sanderegg

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+## Long story short
+
+<!-- Please describe your problem and why the fix is important. -->
+
+## Expected behaviour
+
+<!-- What is the behaviour you expect? -->
+
+## Actual behaviour
+
+<!-- What's actually happening? -->
+
+## Steps to reproduce
+
+<!-- Please describe steps to reproduce the issue.
+     If you have a script that does that please include it here within
+     markdown code markup -->
+
+## Your environment
+
+<!-- Describe the environment you have that lead to your issue.
+     This includes aiohttp version, OS, proxy server and other bits that
+     are related to your case.
+
+     IMPORTANT: aiohttp is both server framework and client library.
+     For getting rid of confusing please put 'server', 'client' or 'both'
+     word here.
+     -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest an idea to implement in the simcore plaform
+
+---
+
+**USER STORY:**
+
+A clear and concise description of how the feature works and looks like from the user's perspective.
+
+Ex. I want to be able the stop the running pipeline by pressing a stop button. If the pipeline is stopped, I see a info-level message confirming it in the logger, if it fails the message should be displayed in red (error). Also, all the progress bars in the nodes must be set to 0.
+
+**DEFINITION OF DONE:**
+
+A clear and concise description of what the feature requires.
+
+0. Play button turns into stop button when pipeline is running
+1. Stop button turns into play button when pipeline is finished
+2. Stop button turns into play button when pipeline is successfully stopped
+3. Logger displays messages everytime the play/stop button is pressed
+4. Progress bars are set to 0 when stopping pipeline
+5. Stop button has a Python interface
+
+**EXAMPLE:**
+
+Any file/screenshot/photomontage/video/website is provided for a better understanding of the request

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,33 @@
+<!-- Thank you for your contribution!
+
+ - Add **WIP-** prefix in title if it is still work in progress (i.e. should not be merged but is ready to start reviewing it)
+ - Use [waffle.io] keywords in title/descriptions to trigger bot actions:
+   - close, closes, close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved #[issueNumber]
+   - connect to, connects to, connected to, connect, connects, connected #[issueNumber]
+   - parent of, parent to, parent #[issueNumber]
+   - child of, child to, child #[issueNumber]
+   - blocks, block, required by, needed by, dependency of #[issueNumber]
+   - blocked by, required, require, needs, need, depends on #[issueNumber]
+-->
+
+## What do these changes do?
+
+<!-- Please give a short brief about these changes. -->
+
+
+## Related issue number
+
+<!-- Are there any issues opened that will be resolved by merging this change?
+
+ - add mentions of the user or team responsible for reviewing proposed changes
+ - and user/team to .github/CODEOWNERS to automatically assign reviewers
+-->
+
+## Checklist
+
+- [ ] I think the code is well written
+- [ ] Unit tests for the changes exist
+- [ ] Documentation reflects the changes
+- [ ] If you design a new module, add your user to .github/CODEOWNERS
+
+[waffle.io]:https://waffle.io/marketing-assets/documents/waffleio_cheatsheet_v1.pdf?utm_source=blog&utm_medium=cheatsheet-ctabutton&utm_campaign=cheatsheet

.gitignore

@@ -121,5 +121,10 @@ out/
 # temporary folders
 tmp/
 
-# explicit mark 
+
+# explicit mark
 *ignore*
+.tmp*
+
+# vscode configuration
+.vscode

.travis.yml

@@ -6,7 +6,8 @@ addons:
       - "python3-pip"
 python:
   - "3.6"
-install: 
+install:
   - "pip install --upgrade pip wheel setuptools"
-  - "pip install -r requirements-dev.txt"
-script: pytest
+  - "pip install -r requirements.txt"
+
+script: pytest -s -c pytest.ini

.vscode-template/settings.json

@@ -0,0 +1,38 @@
+{
+  "editor.tabSize": 2,
+  "editor.insertSpaces": true,
+  "editor.detectIndentation": false,
+  "eslint.alwaysShowStatus": true,
+  "files.associations": {
+    ".*rc": "ini",
+    ".env*": "ini",
+    "Dockerfile*": "dockerfile",
+    "**/requirements/*.txt": "pip-requirements",
+    "**/requirements/*.in": "pip-requirements"
+  },
+  "files.eol": "\n",
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true,
+  "python.formatting.autopep8Args": [
+    "--max-line-length 140"
+  ],
+  "python.linting.pylintEnabled": true,
+  "python.linting.enabled": true,
+  "[python]": {
+    "editor.detectIndentation": false,
+    "editor.tabSize": 4
+  },
+  "[makefile]": {
+    "editor.insertSpaces": false
+  },
+  "python.unitTest.pyTestArgs": [
+    "services/web/server"
+  ],
+  "python.unitTest.unittestEnabled": false,
+  "python.unitTest.nosetestsEnabled": false,
+  "python.unitTest.pyTestEnabled": true,
+  "python.pythonPath": ".venv/bin/python",
+  "restructuredtext.confPath": "",
+  "autoDocstring.docstringFormat": "sphinx"
+}

CHANGELOG.md

@@ -2,6 +2,8 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+TODO: check towncrier for release notes
+
 ### [Unreleased][unreleased]
 
 #### Added

Makefile

@@ -5,55 +5,110 @@ SHELL = /bin/bash
 
 .SUFFIXES:
 
-# Python virtual environment
-VENV_DIR = $(CURDIR)/venv
+VENV_DIR = $(CURDIR)/.venv
 OUTPUT_DIR = $(CURDIR)/output
 TEMPLATE = $(CURDIR)
 
-.PHONY: clean
-clean:
-	@find "$(CURDIR)" \
-		-name "*.py[cod]" -exec rm -fv {} + -o \
-		-name __pycache__ -exec rm -rfv {} +
-	@rm -rfv \
-		"$(CURDIR)/.cache" \
-		"$(CURDIR)/.mypy_cache" \
-		"$(CURDIR)/.pytest_cache"	
-	@rm -rf "$(VENV_DIR)"
-	@rm -rf "$(OUTPUT_DIR)"
+## Tools
+tools =
+
+ifeq ($(shell uname -s),Darwin)
+	SED = gsed
+else
+	SED = sed
+endif
 
+ifeq ($(shell which ${SED}),)
+	tools += $(SED)
+endif
+
+
+## -------------------------------
+# All.
+
+all: help
+ifdef tools
+	$(error "Can't find tools:${tools}")
+endif
+
+
+#-----------------------------------
 .PHONY: install
+# target: install – installs all tooling to run and test current cookie-cutter
 install: venv
-	. "$(VENV_DIR)/bin/activate" && pip install -r requirements-dev.txt
+	. "$(VENV_DIR)/bin/activate" && pip install -r requirements.txt
 
 
+#-----------------------------------
 $(OUTPUT_DIR):
 	@mkdir -p $(OUTPUT_DIR)
-	. "$(VENV_DIR)/bin/activate" && cookiecutter --output-dir "$(OUTPUT_DIR)" "$(TEMPLATE)" 
-
+	. "$(VENV_DIR)/bin/activate" && cookiecutter --output-dir "$(OUTPUT_DIR)" "$(TEMPLATE)"
 
 .PHONY: run
-# target: run - Runs cookiecutter into output folder
-run: $(OUTPUT_DIR) venv
-
-.PHONY: replay
-replay:
-	. "$(VENV_DIR)/bin/activate" && cookiecutter --no-input -f --config-file=".cookiecutterrc-ignore"  --output-dir "$(OUTPUT_DIR)" "$(TEMPLATE)" 
+# target: run – runs cookiecutter into output folder
+run: install $(OUTPUT_DIR)
+	@touch .tmp-ran
 
+.tmp-ran: run
 
+#-----------------------------------
+.PHONY: replay
+# target: replay – replays cookiecutter using customized .cookiecutterrc-ignore
+replay: .tmp-ran
+	. "$(VENV_DIR)/bin/activate" && cookiecutter --no-input -f --config-file=".cookiecutterrc-ignore"  --output-dir "$(OUTPUT_DIR)" "$(TEMPLATE)"
 
+#-----------------------------------
 .PHONE: test
+# target: test – tests backed cookie
 test: install
 	. "$(VENV_DIR)/bin/activate" && pytest -s -c $(CURDIR)/pytest.ini
 
-
-
+#-----------------------------------
 $(VENV_DIR):
 	@python3 -m venv "$(VENV_DIR)"
 	@"$(VENV_DIR)/bin/pip3" install --upgrade pip wheel setuptools
-	@"$(VENV_DIR)/bin/pip3" install pylint
-	@echo "To activate the virtual environment, execute 'source env/bin/activate'"
+	@echo "To activate the virtual environment, execute 'source $(VENV_DIR)/bin/activate'"
 
 .PHONY: venv
-# target: env – Create the virtual environment into venv folder
-venv: $(VENV_DIR)
+# target: venv – Create the virtual environment into venv folder
+venv: $(VENV_DIR)
+.venv: $(VENV_DIR)
+
+
+.PHONY: venv
+# target: requirements – Pip compile requirements.in
+requirements: requirements.in
+	pip-compile -v --output-file requirements.txt requirements.in
+	@touch requirements.txt
+
+
+
+## -------------------------------
+# Auxiliary targets.
+
+.PHONY: help
+# target: help – Display all callable targets
+help:
+	@echo
+	@egrep "^\s*#\s*target\s*:\s*" [Mm]akefile \
+	| $(SED) -r "s/^\s*#\s*target\s*:\s*//g"
+	@echo
+
+
+.PHONY: clean
+# target: clean – cleans projects directory
+clean:
+	@find "$(CURDIR)" \
+		-name "*.py[cod]" -exec rm -fv {} + -o \
+		-name __pycache__ -exec rm -rfv {} +
+	@rm -rfv \
+		"$(CURDIR)/.cache" \
+		"$(CURDIR)/.mypy_cache" \
+		"$(CURDIR)/.pytest_cache"
+	@rm -rf "$(OUTPUT_DIR)"
+	@rm .tmp-*
+
+
+# target: clean-force – cleans & removes also venv folder
+clean-force: clean
+	@rm -rf "$(VENV_DIR)"