Metadata-Version: 2.1
Name: resolwe
Version: 29.0.0a1
Summary: Open source enterprise dataflow engine in Django
Home-page: https://github.com/genialis/resolwe
Author: Genialis, Inc.
Author-email: dev-team@genialis.com
License: Apache License (2.0)
Keywords: resolwe dataflow django
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
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
Requires-Python: >=3.6, <3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: asgiref (~=3.3.1)
Requires-Dist: asteval (==0.9.23)
Requires-Dist: async-timeout (~=3.0.0)
Requires-Dist: channels (~=3.0.3)
Requires-Dist: channels-redis (~=3.2.0)
Requires-Dist: crcmod
Requires-Dist: kubernetes (~=12.0.1)
Requires-Dist: docker (~=4.4.4)
Requires-Dist: Django (~=3.1.7)
Requires-Dist: djangorestframework (~=3.12.2)
Requires-Dist: django-filter (~=2.4.0)
Requires-Dist: django-guardian (~=2.3.0)
Requires-Dist: django-versionfield (~=1.0.2)
Requires-Dist: django-fernet-fields (~=0.6)
Requires-Dist: django-priority-batch (==3.*,>=3.0a1)
Requires-Dist: Jinja2 (~=2.11.3)
Requires-Dist: jsonschema (~=3.2.0)
Requires-Dist: plumbum (~=1.7.0)
Requires-Dist: psycopg2-binary (~=2.8.6)
Requires-Dist: PyYAML (~=5.4.1)
Requires-Dist: redis (~=3.5.3)
Requires-Dist: shellescape (~=3.8.1)
Requires-Dist: beautifulsoup4 (~=4.9.3)
Requires-Dist: Sphinx (~=3.5.3)
Requires-Dist: wrapt (~=1.12.1)
Requires-Dist: pyzmq (~=22.0.3)
Provides-Extra: docs
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: pyasn1 (>=0.4.8) ; extra == 'docs'
Provides-Extra: package
Requires-Dist: twine ; extra == 'package'
Requires-Dist: wheel ; extra == 'package'
Provides-Extra: storage_gcs
Requires-Dist: crcmod ; extra == 'storage_gcs'
Requires-Dist: google-cloud-storage (~=1.35.0) ; extra == 'storage_gcs'
Provides-Extra: storage_s3
Requires-Dist: boto3 (~=1.17.29) ; extra == 'storage_s3'
Requires-Dist: crcmod ; extra == 'storage_s3'
Provides-Extra: test
Requires-Dist: black (>=20.8b1) ; extra == 'test'
Requires-Dist: check-manifest (>=0.46) ; extra == 'test'
Requires-Dist: coverage (>=5.3.1) ; extra == 'test'
Requires-Dist: flake8 (>=3.8.4) ; extra == 'test'
Requires-Dist: pydocstyle (>=5.1.1) ; extra == 'test'
Requires-Dist: readme-renderer ; extra == 'test'
Requires-Dist: setuptools-scm ; extra == 'test'
Requires-Dist: testfixtures (>=6.17.1) ; extra == 'test'
Requires-Dist: tblib (>=1.7.0) ; extra == 'test'
Requires-Dist: isort (>=5.7.0) ; extra == 'test'

=======
Resolwe
=======

|build| |coverage| |docs| |black| |pypi_version| |pypi_pyversions| |pypi_downloads|

.. |build| image:: https://github.com/genialis/resolwe/workflows/Resolwe%20CI/badge.svg?branch=master
    :target: https://github.com/genialis/resolwe/actions?query=branch%3Amaster
    :alt: Build Status

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

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

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style Black

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

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

.. |pypi_downloads| image:: https://pepy.tech/badge/resolwe
    :target: https://pepy.tech/project/resolwe
    :alt: Number of downloads from PyPI

Resolwe is an open source dataflow package for `Django framework`_. We envision
Resolwe to follow the `Common Workflow Language`_ specification, but the
current implementation does not yet fully support it. Resolwe offers a complete
RESTful API to connect with external resources. A collection of bioinformatics
pipelines is available in `Resolwe Bioinformatics`_.

.. _Django framework: https://www.djangoproject.com/
.. _Common Workflow Language: https://github.com/common-workflow-language/common-workflow-language
.. _Resolwe Bioinformatics: https://github.com/genialis/resolwe-bio


Docs & Help
===========

Read about architecture, getting started, how to write `processes`, RESTful API
details, and API Reference in the documentation_.

To chat with developers or ask for help, join us on Slack_.

.. _documentation: http://resolwe.readthedocs.io/
.. _Slack: http://resolwe.slack.com/


Install
=======

Prerequisites
-------------

Resolwe runs on Python_ 3.6 or later If you don't have it yet, follow `these
instructions <https://docs.python.org/3/using/index.html>`__.

It's easiest to run other required services in Docker containers If you don't
have it yet, you can follow the `official Docker tutorial`_ for Mac and for
Windows or install it as a distribution's package in most of standard Linux
distributions (Fedora, Ubuntu,...).

.. _Python: https://www.python.org/
.. _official Docker tutorial: https://docs.docker.com/get-started/

Using PyPI_
-----------

.. code::

    pip install resolwe

.. _PyPI: https://pypi.org/

Using source on GitHub_
-----------------------

.. code::

   pip install https://github.com/genialis/resolwe/archive/<git-tree-ish>.tar.gz

where ``<git-tree-ish>`` can represent any commit SHA, branch name, tag name,
etc. in `Resolwe's GitHub repository`_. For example, to install the latest
Resolwe from the ``master`` branch, use:

.. code::

   pip install https://github.com/genialis/resolwe/archive/master.tar.gz

.. _`Resolwe's GitHub repository`: https://github.com/genialis/resolwe/
.. _GitHub: `Resolwe's GitHub repository`_


Contribute
==========

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

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


