docs: initial release #4

hjhsalo · 2017-05-26T08:19:20Z

add initial documentation structure, with license authors, etc.
(closes docs: initial release #1)
basic functionality to test client-server connection with ping

Signed-off-by: Harri Hirvonsalo harri.hirvonsalo@cern.ch

hjhsalo · 2017-05-26T08:20:34Z

~~Note that #1 mentions a Dockerfile and this commit doesn't include one.~~

diegodelemos · 2017-05-26T09:03:31Z

README.rst

-==============
+======================
+REANA Server
+======================


Any reason for having additional =? I remember that for the release checklist for Invenio we had to stick to the length of the tittle itself.

No reason. It's an error.

diegodelemos · 2017-05-26T09:11:18Z

reana_server/app.py

+from flask import Flask
+
+app = Flask(__name__)
+app.secret_key = "hyper secret key"


¯_(ツ)_/¯
had to change something to make it more original :D

diegodelemos · 2017-05-26T09:13:13Z

reana_server/app.py

+
+    ---
+    get:
+      summary: Ping the server. Responds with pong and HTTP 200


Responds with pong and HTTP 200

Isn't it a bit redundant if we already document all the responses below? It will be rendered along with the responses when we do the sphinxcontrib-openapi 🙃

diegodelemos · 2017-05-28T10:41:37Z

Why is Dockerfile not included? We will need it to build the image and deploy the service. Moreover, adding the build to CI like here would be of great help.

diegodelemos · 2017-05-28T10:44:57Z

reana_server/config.py

+# granted to it by virtue of its status as an Intergovernmental Organization or
+# submit itself to any jurisdiction.
+
+"""Flask application configuration."""


do we want to keep this empty file?

diegodelemos · 2017-05-28T10:45:19Z

reana_server/app.py

+        format='%(asctime)s - %(threadName)s - %(levelname)s: %(message)s'
+    )
+
+    app.config.from_object('config')


Loading empty config? do we need it?

diegodelemos · 2017-05-28T10:52:52Z

setup.py

+    url='https://github.com/reanahub/reana-server',
+    packages=['reana_server'],
+    zip_safe=False,
+    extras_require=extras_require,


install_requires=install_requires, missing

diegodelemos · 2017-05-28T11:19:45Z

reana_server/app.py

+
+@app.route('/ping', methods=['GET'])
+def ping():  # noqa
+    r"""Endpoint to ping the server. Responds with a pong.


Shall we plug apispec and sphinxcontrib-openapi already as here reanahub/reana-job-controller#40? We will need it if we want to show API docs...
If we do so, take into account pinning Sphinx see reanahub/reana-job-controller#43

tiborsimko · 2017-06-07T08:14:56Z

reana_server/app.py

+            Ping succeeded.
+          examples:
+            application/text:
+              pong


Usually we used to return OK, see for example http://opendata.cern.ch/ping

hjhsalo · 2017-06-08T14:13:53Z

scripts/generate_openapi_spec.py

+@click.command()
+@click.option('-n', '--name', default="Reana package",
+              help='Name of package/component', envvar='REANA_PACKAGE_NAME')
+@click.option('-d', '--description', default="API description",


Better naming suggestions for these environment variables? e.g. PACKAGE_OAPI_VERSION is not that explanatory and without checking it out or without documentation (e.g. line comments) it is immediately clear what VERSION means in this context.

diegodelemos · 2017-06-08T14:24:09Z

docs/restapi.rst

+REST API
+========
+
+The REANA Server offers a REST API for management of workflow running in REANA


I am not sure if this would be s/workflow/analyses, or not specifying anything at all and just saying management of the REANA Cloud. Anyhow, not only workflows (understanding that analyses includes also single job/step tasks like https://github.com/reanahub/reana-demo-helloworld once we remove yadage)

diegodelemos · 2017-06-08T14:29:31Z

scripts/generate_openapi_spec.py

+                             errors='strict', lazy=False,
+                             atomic=False) as output:
+            output.write(json.dumps(spec.to_dict(), indent=2, sort_keys=True))
+            output.close()


You can delete this since you are inside a context manager, can't you?

tiborsimko · 2017-06-16T09:19:12Z

@hjhsalo Have you had a look to the Travis CI failure?

tiborsimko · 2017-06-16T09:38:53Z

Dockerfile

+# granted to it by virtue of its status as an Intergovernmental Organization or
+# submit itself to any jurisdiction.
+
+FROM python:3.5-alpine


Elsewhere we are using FROM python:3.5.

It might be good to standardise on some base everywhere in order to avoid surprises, see for example why Elastic moved away from Alpine https://www.elastic.co/blog/docker-base-centos7

"It might be good to standardize on some base everywhere in order to avoid surprises"

There has been discussions about moving to Alpine in order to achieve smaller image sizes. The usage of python:3.5-alpine in reana-server is intentional. Motivation for this is to find out possible problems with the way current Dockerfile(s) of various REANA components are written.

I've seen and read the blog post in the past.

tiborsimko · 2017-06-16T09:39:42Z

Dockerfile

+    chown -R reanauser /code
+USER reanauser
+EXPOSE 5000
+CMD ["python", "reana_server/app.py"]


FLASK_APP=... and flask run?

tiborsimko · 2017-06-16T09:41:08Z

run-tests.sh

+pydocstyle reana_server && \
+isort -rc -c -df **/*.py && \
+FLASK_APP=reana_server/app.py python ./scripts/generate_openapi_spec.py && \
+diff temp_openapi.json docs/openapi.json && \


diff -w should take care of the Travis CI problem

tiborsimko · 2017-06-16T09:42:50Z

scripts/generate_openapi_spec.py

+
+@click.command()
+@click.option('-t', '--title',
+              help='Title of package/component exposing the API')


If people will copy/paste this code, as it were, then perhaps help=__title__ directly?

(And ditto for description, version, etc.)

* add initial documentation structure, with license authors, etc. (closes reanahub#1) * basic functionality to test client-server connection with ping Signed-off-by: Harri Hirvonsalo <harri.hirvonsalo@cern.ch>

hjhsalo added the Status: in review label May 26, 2017

diegodelemos reviewed May 26, 2017

View reviewed changes

hjhsalo force-pushed the enhance-repo-structure branch 2 times, most recently from 5622fd9 to 8661a7e Compare May 26, 2017 15:37

diegodelemos reviewed May 28, 2017

View reviewed changes

diegodelemos added the Need: work label May 28, 2017

diegodelemos assigned hjhsalo May 29, 2017

tiborsimko reviewed Jun 7, 2017

View reviewed changes

hjhsalo force-pushed the enhance-repo-structure branch 3 times, most recently from db79f4e to d8e5d1d Compare June 8, 2017 13:24

hjhsalo commented Jun 8, 2017

View reviewed changes

diegodelemos reviewed Jun 8, 2017

View reviewed changes

hjhsalo force-pushed the enhance-repo-structure branch 9 times, most recently from 73c78c5 to 91f0db9 Compare June 14, 2017 13:20

hjhsalo force-pushed the enhance-repo-structure branch from 91f0db9 to 91809bf Compare June 16, 2017 09:36

tiborsimko reviewed Jun 16, 2017

View reviewed changes

hjhsalo force-pushed the enhance-repo-structure branch 3 times, most recently from 0a54827 to 52d1ab8 Compare June 16, 2017 16:12

tiborsimko approved these changes Jun 16, 2017

View reviewed changes

docs: initial release

e57ab25

* add initial documentation structure, with license authors, etc. (closes reanahub#1) * basic functionality to test client-server connection with ping Signed-off-by: Harri Hirvonsalo <harri.hirvonsalo@cern.ch>

hjhsalo force-pushed the enhance-repo-structure branch from 52d1ab8 to e57ab25 Compare June 16, 2017 16:27

tiborsimko merged commit e57ab25 into reanahub:master Jun 16, 2017

tiborsimko removed the Status: in review label Jun 16, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: initial release #4

docs: initial release #4

hjhsalo commented May 26, 2017

hjhsalo commented May 26, 2017 •

edited

diegodelemos May 26, 2017

hjhsalo May 26, 2017

diegodelemos May 26, 2017

hjhsalo May 26, 2017

diegodelemos May 26, 2017

diegodelemos commented May 28, 2017

diegodelemos May 28, 2017

diegodelemos May 28, 2017

diegodelemos May 28, 2017

diegodelemos May 28, 2017

tiborsimko Jun 7, 2017

hjhsalo Jun 8, 2017

diegodelemos Jun 8, 2017

diegodelemos Jun 8, 2017

tiborsimko commented Jun 16, 2017

tiborsimko Jun 16, 2017

hjhsalo Jun 16, 2017

tiborsimko Jun 16, 2017

tiborsimko Jun 16, 2017

tiborsimko Jun 16, 2017

tiborsimko Jun 16, 2017

docs: initial release #4

docs: initial release #4

Conversation

hjhsalo commented May 26, 2017

hjhsalo commented May 26, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diegodelemos commented May 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tiborsimko commented Jun 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hjhsalo commented May 26, 2017 •

edited