Metadata-Version: 2.1
Name: reana-commons
Version: 0.8.0a9
Summary: REANA-Commons.
Home-page: https://github.com/reanahub/reana-commons
Author: REANA
Author-email: info@reana.io
License: UNKNOWN
Description: #############
        REANA-Commons
        #############
        
        .. image:: https://img.shields.io/pypi/pyversions/reana-commons.svg
              :target: https://pypi.org/pypi/reana-commons
        
        .. image:: https://github.com/reanahub/reana-commons/workflows/CI/badge.svg
              :target: https://github.com/reanahub/reana-commons/actions
        
        .. image:: https://readthedocs.org/projects/reana-commons/badge/?version=latest
              :target: https://reana-commons.readthedocs.io/en/latest/?badge=latest
        
        .. image:: https://codecov.io/gh/reanahub/reana-commons/branch/master/graph/badge.svg
              :target: https://codecov.io/gh/reanahub/reana-commons
        
        .. image:: https://badges.gitter.im/Join%20Chat.svg
              :target: https://gitter.im/reanahub/reana?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
        
        .. image:: https://img.shields.io/github/license/reanahub/reana-commons.svg
              :target: https://github.com/reanahub/reana-commons/blob/master/LICENSE
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/psf/black
        
        About
        =====
        
        REANA-Commons is a component of the `REANA <http://www.reana.io/>`_ reusable and
        reproducible research data analysis platform. It provides common utilities and
        schemas shared by the REANA cluster components.
        
        Features
        ========
        
        - common API clients for internal communication
        - centralised OpenAPI specifications for REANA components
        - AMQP connection management and communication
        - utility functions for cluster components
        
        Usage
        =====
        
        The detailed information on how to install and use REANA can be found in
        `docs.reana.io <https://docs.reana.io>`_.
        
        Useful links
        ============
        
        - `REANA project home page <http://www.reana.io/>`_
        - `REANA user documentation <https://docs.reana.io>`_
        - `REANA user support forum <https://forum.reana.io>`_
        
        - `REANA-Commons releases <https://reana-commons.readthedocs.io/en/latest#changes>`_
        - `REANA-Commons developer documentation <https://reana-commons.readthedocs.io/>`_
        - `REANA-Commons known issues <https://github.com/reanahub/reana-commons/issues>`_
        - `REANA-Commons source code <https://github.com/reanahub/reana-commons>`_
        
        
        Changes
        =======
        
        Version master (UNRELEASED)
        ---------------------------
        
        - Adds `get_disk_usage` utility function to calculate disk usage for a directory.
        - Centralises `fs` package dependency
        
        Version 0.7.2 (UNRELEASED)
        --------------------------
        
        - Adds support for Python 3.9.
        - Fixes minor code warnings.
        
        Version 0.7.1 (2020-11-09)
        --------------------------
        
        - Adds support for restarting yadage workflows (through ``accept_metadir`` operational option).
        - Allows ``htcondor_max_runtime`` and ``htcondor_accounting_group`` to be specified for HTC jobs.
        - Adds new field in REANA-Server OpenAPI spec to return server version.
        - Changes CI system from Travis to GitHub Actions.
        
        Version 0.7.0 (2020-10-20)
        --------------------------
        
        - Adds new utility to send emails.
        - Adds centralised validation utility for workflow operational options.
        - Adds new configuration variable to set the maximum number of running workflows. (``REANA_MAX_CONCURRENT_BATCH_WORKFLOWS``)
        - Adds new configuration variable to set prefix of REANA cluster component names. (``REANA_COMPONENT_PREFIX``)
        - Adds new configuration variable for the runtime pod node selector label. (``REANA_RUNTIME_KUBERNETES_NODE_LABEL``)
        - Adds new configuration variable to define the Kubernetes namespace in which REANA infrastructure components run. (``REANA_INFRASTRUCTURE_KUBERNETES_NAMESPACE``)
        - Adds new configuration variable to define the Kubernetes namespace in which REANA runtime components components run. (``REANA_RUNTIME_KUBERNETES_NAMESPACE``)
        - Adds possibility to specify unpacked container images for running jobs.
        - Adds support for ``initfiles`` operational option for the Yadage workflow engine.
        - Fixes memory leak in Bravado client instantiation.
        - Changes CephFS Persistent Volume Claim name. (``REANA_SHARED_PVC_NAME``)
        - Changes default logging level to ``INFO``.
        - Changes default CVMFS volume list to include LHCb Gaudi related workflows.
        - Changes code formatting to respect ``black`` coding style.
        - Changes underlying requirements to use Kubernetes Python library version 11.
        - Changes underlying requirements to use latest CVMFS CSI driver version.
        - Changes documentation to single-page layout.
        
        Version 0.6.1 (2020-05-25)
        --------------------------
        
        - Upgrades Kubernetes Python client.
        
        Version 0.6.0 (2019-12-19)
        --------------------------
        
        - Adds new API for Gitlab integration.
        - Adds new Kubernetes client API for ingresses.
        - Adds new APIs for management of user secrets.
        - Adds EOS storage Kubernetes configuration.
        - Adds HTCondor and Slurm compute backends.
        - Adds support for streaming file uploads.
        - Allows unpacked CVMFS and CMS open data volumes.
        - Adds Serial workflow step name and compute backend.
        - Adds support for Python 3.8.
        
        Version 0.5.0 (2019-04-16)
        --------------------------
        
        - Centralises log level and log format configuration.
        - Adds new utility to inspect the disk usage on a given workspace.
          (``get_workspace_disk_usage``)
        - Introduces the module to share Celery tasks accross REANA
          components. (``tasks.py``)
        - Introduces common Celery task to determine whether REANA can
          execute new workflows depending on a set of conditions
          such as running job count. (``reana_ready``, ``check_predefined_conditions``,
          ``check_running_job_count``)
        - Allows the AMQP consumer to be configurable with multiple queues.
        - Introduces new queue for workflow submission. (``workflow-submission``)
        - Introduces new publisher for workflow submissions.
          (``WorkflowSubmissionPublisher``)
        - Centralises Kubernetes API client configuration and initialisation.
        - Adds Kubernetes specific configuration for CVMFS volumes as utils.
        - Introduces a new method, ``copy_openapi_specs``, to automatically move
          validated OpenAPI specifications from components to REANA Commons
          ``openapi_specifications`` directory.
        - Centralises interactive session types.
        - Introduces central REANA errors through the ``errors.py`` module.
        - Skips SSL verification for all HTTPS requests performed with the
          ``BaseAPIClient``.
        
        Version 0.4.0 (2018-11-06)
        --------------------------
        
        - Aggregates OpenAPI specifications of REANA components.
        - Improves AMQP re-connection handling. Switches from ``pika`` to ``kombu``.
        - Enhances test suite and increases code coverage.
        - Changes license to MIT.
        
        Version 0.3.1 (2018-09-04)
        --------------------------
        
        - Adds parameter expansion and validation utilities for parametrised Serial
          workflows.
        
        Version 0.3.0 (2018-08-10)
        --------------------------
        
        - Initial public release.
        - Provides basic AMQP pub/sub methods for REANA components.
        - Utilities for caching used in different REANA components.
        - Click formatting helpers.
        
        .. admonition:: Please beware
        
           Please note that REANA is in an early alpha stage of its development. The
           developer preview releases are meant for early adopters and testers. Please
           don't rely on released versions for any production purposes yet.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: docs
Provides-Extra: tests
Provides-Extra: kubernetes
Provides-Extra: all
