global: Black support

CHANGES.rst

@@ -1,6 +1,23 @@
 Changes
 =======
 
+Version master (UNRELEASED)
+---------------------------
+
+- Moves to Helm deployment.
+- Adds command to bump common packages versions.
+- Supports prefixing by Helm release name.
+- Adds Helm Chart repo site.
+- Adds new ``python-unit-tests`` command.
+- Moves part of the documentation to docs.reana.io.
+- Adds Chart Release GitHub action.
+- Drops Python 2 support.
+- Adds email notificator service.
+- Moves database initialisation and admin creation after Helm installation.
+- Adds cronjob to send periodical status reports.
+- Adds announcement configmap configuration to display on the UI.
+- Adds Black formatter support.
+
 Version 0.6.0 (2019-12-27)
 --------------------------
 

Makefile

@@ -238,7 +238,7 @@ teardown: # Destroy local host virtual environment and Minikube. All traces go.
 
 test: # Run unit tests on the REANA package.
 	pydocstyle reana
-	isort -rc -c -df **/*.py
+	black --check .
 	check-manifest --ignore ".travis-*"
 	sphinx-build -qnNW docs docs/_build/html
 	python setup.py test

README.rst

@@ -17,6 +17,9 @@
 .. image:: https://img.shields.io/github/license/reanahub/reana.svg
    :target: https://github.com/reanahub/reana/blob/master/LICENSE
 
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+
 About
 -----
 

benchmark/locustfile.py

@@ -26,25 +26,23 @@
 
 from locust import HttpLocust, TaskSet, between, task
 
-TOKEN = os.environ.get('REANA_ACCESS_TOKEN')
+TOKEN = os.environ.get("REANA_ACCESS_TOKEN")
 
 dummy_spec = {
     "workflow": {
         "specification": {
             "steps": [
                 {
                     "environment": "reanahub/reana-env-jupyter",
-                    "commands": [
-                        "echo 'Hello REANA'"
-                    ]
+                    "commands": ["echo 'Hello REANA'"],
                 }
             ]
         },
         "type": "serial",
     },
 }
 
-workflow_name = 'myworkflow'
+workflow_name = "myworkflow"
 
 
 class WorkflowsTaskSet(TaskSet):
@@ -57,27 +55,29 @@ def on_start(self):
     def setup(self):
         """Create 10 workflows to query them."""
         for _ in range(10):
-            self.client.post('/api/workflows',
-                             params=(('workflow_name', workflow_name),
-                                     ('access_token', TOKEN)),
-                             json=dummy_spec, verify=False)
+            self.client.post(
+                "/api/workflows",
+                params=(("workflow_name", workflow_name), ("access_token", TOKEN)),
+                json=dummy_spec,
+                verify=False,
+            )
 
     @task
     def ping(self):
         """Ping reana instance."""
-        self.client.get(f'/api/ping')
+        self.client.get(f"/api/ping")
 
     @task
     def get_worflows(self):
         """Get workflows."""
-        self.client.get(f'/api/workflows',
-                        params=(('access_token', TOKEN),))
+        self.client.get(f"/api/workflows", params=(("access_token", TOKEN),))
 
     @task
     def get_worflow_logs(self):
         """Get workflow logs."""
-        self.client.get(f'/api/workflows/{workflow_name}/logs',
-                        params=(('access_token', TOKEN),))
+        self.client.get(
+            f"/api/workflows/{workflow_name}/logs", params=(("access_token", TOKEN),)
+        )
 
 
 class WebsiteUser(HttpLocust):

docs/conf.py

@@ -34,38 +34,38 @@
 # needs_sphinx = '1.0'
 
 # Do not warn on external images.
-suppress_warnings = ['image.nonlocal_uri']
+suppress_warnings = ["image.nonlocal_uri"]
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.doctest',
-    'sphinx.ext.graphviz',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
-    'sphinx_click.ext',
-    'sphinxcontrib.programoutput',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.doctest",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx_click.ext",
+    "sphinxcontrib.programoutput",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'reana'
-copyright = '2017, 2018, 2019, info@reana.io'
-author = 'info@reana.io'
+project = "reana"
+copyright = "2017, 2018, 2019, info@reana.io"
+author = "info@reana.io"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -75,9 +75,9 @@
 
 # Get the version string. Cannot be done with import!
 g = {}
-with open(os.path.join('..', 'reana', 'version.py'), 'rt') as fp:
+with open(os.path.join("..", "reana", "version.py"), "rt") as fp:
     exec(fp.read(), g)
-    version = g['__version__']
+    version = g["__version__"]
 
 # The full version, including alpha/beta/rc tags.
 release = version
@@ -92,10 +92,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -106,52 +106,52 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 html_theme_options = {
-    'logo': 'logo-reana.png',
-    'description': """<p><a href="http://www.reana.io">REANA</a> is a reusable and reproducible
+    "logo": "logo-reana.png",
+    "description": """<p><a href="http://www.reana.io">REANA</a> is a reusable and reproducible
                       research data analysis platform.</p><p>Structure your
                       analysis inputs, code, environments, workflows and run
                       your analysis on remote containerised compute
                       clouds.</p>""",
-    'github_user': 'reanahub',
-    'github_repo': 'reana',
-    'github_button': False,
-    'github_banner': True,
-    'show_powered_by': False,
-    'extra_nav_links': {
-        'REANA@DockerHub': 'https://hub.docker.com/u/reanahub/',
-        'REANA@GitHub': 'https://github.com/reanahub',
-        'REANA@Twitter': 'https://twitter.com/reanahub',
-        'REANA@Web': 'http://www.reana.io',
-    }
+    "github_user": "reanahub",
+    "github_repo": "reana",
+    "github_button": False,
+    "github_banner": True,
+    "show_powered_by": False,
+    "extra_nav_links": {
+        "REANA@DockerHub": "https://hub.docker.com/u/reanahub/",
+        "REANA@GitHub": "https://github.com/reanahub",
+        "REANA@Twitter": "https://twitter.com/reanahub",
+        "REANA@Web": "http://www.reana.io",
+    },
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',
-        'searchbox.html',
-        'donate.html',
+    "**": [
+        "about.html",
+        "navigation.html",
+        "relations.html",
+        "searchbox.html",
+        "donate.html",
     ]
 }
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'reanadoc'
+htmlhelp_basename = "reanadoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -160,15 +160,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -178,19 +175,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'reana.tex', 'reana Documentation',
-     'info@reana.io', 'manual'),
+    (master_doc, "reana.tex", "reana Documentation", "info@reana.io", "manual"),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'reana', 'reana Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "reana", "reana Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -199,7 +192,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'reana', 'reana Documentation',
-     author, 'reana', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "reana",
+        "reana Documentation",
+        author,
+        "reana",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

pytest.ini

@@ -5,4 +5,4 @@
 # under the terms of the MIT License; see LICENSE file for more details.
 
 [pytest]
-addopts = --pep8 --ignore=docs --cov=reana --cov-report=term-missing
+addopts = --ignore=docs --cov=reana --cov-report=term-missing

reana/__init__.py

@@ -12,4 +12,4 @@
 
 from .version import __version__
 
-__all__ = ('__version__', )
+__all__ = ("__version__",)