Metadata-Version: 2.1
Name: resolwe
Version: 19.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
Requires-Python: >=3.6, <3.8
Description-Content-Type: text/x-rst
Requires-Dist: asteval (~=0.9.12)
Requires-Dist: async-timeout (~=3.0.0)
Requires-Dist: channels (~=2.2.0)
Requires-Dist: channels-redis (~=2.4.0)
Requires-Dist: Django (~=2.2.0)
Requires-Dist: djangorestframework (~=3.9.0)
Requires-Dist: django-filter (~=2.0.0)
Requires-Dist: django-guardian (~=1.5.0)
Requires-Dist: django-versionfield2 (~=0.5.0)
Requires-Dist: django-fernet-fields (~=0.5)
Requires-Dist: django-priority-batch (~=2.0.0)
Requires-Dist: elasticsearch-dsl (~=6.3.1)
Requires-Dist: Jinja2 (~=2.10.1)
Requires-Dist: jsonschema (~=2.6.0)
Requires-Dist: plumbum (~=1.6.6)
Requires-Dist: psycopg2-binary (~=2.8.0)
Requires-Dist: PyYAML (~=5.1)
Requires-Dist: redis (~=3.2.0)
Requires-Dist: resolwe-runtime-utils (~=2.0.1)
Requires-Dist: shellescape (~=3.4.1)
Requires-Dist: Sphinx (<1.7.0,>=1.5.1)
Requires-Dist: urllib3 (~=1.24.2)
Requires-Dist: wrapt (~=1.11.1)
Provides-Extra: docs
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: package
Requires-Dist: twine ; extra == 'package'
Requires-Dist: wheel ; extra == 'package'
Provides-Extra: test
Requires-Dist: check-manifest ; extra == 'test'
Requires-Dist: coverage (>=4.2) ; extra == 'test'
Requires-Dist: pycodestyle (~=2.5.0) ; extra == 'test'
Requires-Dist: pydocstyle (~=3.0.0) ; extra == 'test'
Requires-Dist: pylint (~=2.3.1) ; extra == 'test'
Requires-Dist: readme-renderer ; extra == 'test'
Requires-Dist: setuptools-scm ; extra == 'test'
Requires-Dist: testfixtures (>=4.10.0) ; extra == 'test'
Requires-Dist: tblib (>=1.3.0) ; extra == 'test'
Requires-Dist: isort (~=4.3.12) ; extra == 'test'

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

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

.. |build| image:: https://travis-ci.org/genialis/resolwe.svg?branch=master
    :target: https://travis-ci.org/genialis/resolwe
    :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

.. |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
-------------

Make sure you have Python_ 3.6 installed on your system. If you don't have it
yet, follow `these instructions
<https://docs.python.org/3/using/index.html>`__.

Resolwe requires PostgreSQL_ (9.4+). Many Linux distributions already include
the required version of PostgreSQL (e.g. Fedora 22+, Debian 8+, Ubuntu 15.04+)
and you can simply install it via distribution's package manager.
Otherwise, follow `these instructions
<https://wiki.postgresql.org/wiki/Detailed_installation_guides>`__.

Additionally, installing some (indirect) dependencies from PyPI_ will require
having a C compiler (e.g. GCC_) as well as Python development files installed
on the system.

Note
^^^^

The preferred way to install the C compiler and Python development files is to
use your distribution's packages, if they exist. For example, on a
Fedora/RHEL-based system, that would mean installing ``gcc`` and
``python3-devel`` packages.

.. _Python: https://www.python.org/
.. _PostgreSQL: http://www.postgresql.org/
.. _PyPi: https://pypi.python.org/
.. _GCC: https://gcc.gnu.org/

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

.. code::

    pip install resolwe

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


