Metadata-Version: 2.1
Name: resolwe-runtime-utils
Version: 3.1.1
Summary: Runtime utilities for Resolwe dataflow engine
Home-page: https://github.com/genialis/resolwe-runtime-utils
Author: Genialis, Inc.
Author-email: dev-team@genialis.com
License: Apache License (2.0)
Keywords: resolwe runtime utilities library
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
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
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: package
Provides-Extra: test
License-File: LICENSE
License-File: AUTHORS

=========================
Resolwe Runtime Utilities
=========================

|build| |coverage| |docs| |pypi_version| |pypi_pyversions|

.. |build| image:: https://travis-ci.org/genialis/resolwe-runtime-utils.svg?branch=master
    :target: https://travis-ci.org/genialis/resolwe-runtime-utils
    :alt: Build Status

.. |coverage| image:: https://img.shields.io/codecov/c/github/genialis/resolwe-runtime-utils/master.svg
    :target: http://codecov.io/github/genialis/resolwe-runtime-utils?branch=master
    :alt: Coverage Status

.. |docs| image:: https://readthedocs.org/projects/resolwe-runtime-utils/badge/?version=latest
    :target: http://resolwe-runtime-utils.readthedocs.io/
    :alt: Documentation Status

.. |pypi_version| image:: https://img.shields.io/pypi/v/resolwe-runtime-utils.svg
    :target: https://pypi.python.org/pypi/resolwe-runtime-utils
    :alt: Version on PyPI

.. |pypi_pyversions| image:: https://img.shields.io/pypi/pyversions/resolwe-runtime-utils.svg
    :target: https://pypi.python.org/pypi/resolwe-runtime-utils
    :alt: Supported Python versions

A project that provides convenience utilities for writing processes for the
Resolwe_ dataflow engine.

The ``import_file`` function requires `7z` in path.

You can find more information in the documentation_.

.. _Resolwe: https://github.com/genialis/resolwe
.. _documentation: http://resolwe-runtime-utils.readthedocs.io/

Getting started
---------------

Install Resolwe Runtime Utilities from PyPI_::

    pip install resolwe-runtime-utils

Use them in your Python Resolwe process:

.. code-block:: python

    from resolwe_runtime_utils import info, save_file

    info('Some info')
    save_file('etc', 'foo.py')

Or use them in your Bash Resolwe process::

    re-info "Some info"
    re-save-file "etc" "foo.py"

.. _PyPI: https://pypi.python.org/pypi/resolwe-runtime-utils

Contribute
----------

We welcome new contributors. To learn more, read Contributing_ section of our
documentation.

.. _Contributing: http://resolwe-runtime-utils.readthedocs.io/en/latest/contributing.html


