Open source enterprise dataflow engine in Django
Project description
=======
Resolwe
=======
|build| |coverage| |docs| |pypi_version| |pypi_pyversions|
.. |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-hypernode.com/pypi/resolwe
:alt: Version on PyPI
.. |pypi_pyversions| image:: https://img.shields.io/pypi/pyversions/resolwe.svg
:target: https://pypi-hypernode.com/pypi/resolwe
:alt: Supported Python versions
.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/resolwe.svg
:target: https://pypi-hypernode.com/pypi/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_ (2.7 or 3.4+) 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 the ``psycopg2`` dependency from PyPI_ will require
having a C compiler (e.g. GCC_) as well as Python and PostgreSQL development
files installed on the system.
Note
^^^^
The preferred way to install the C compiler and Python and PostgreSQL
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``,
``python-devel``/``python3-devel`` and ``postgresql-devel`` packages.
.. _Python: https://www.python.org/
.. _PostgreSQL: http://www.postgresql.org/
.. _PyPi: https://pypi-hypernode.com/
.. _GCC: https://gcc.gnu.org/
>From PyPI_
----------
.. code::
pip install --process-dependency-links resolwe
>From source
-----------
.. code::
pip install --process-dependency-links 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 --process-dependency-links https://github.com/genialis/resolwe/archive/master.tar.gz
.. _`Resolwe's GitHub repository`: https://github.com/genialis/resolwe/
Contribute
==========
We welcome new contributors. To learn more, read Contributing_ section of our
documentation.
.. _Contributing: http://resolwe.readthedocs.io/en/latest/contributing.html
Resolwe
=======
|build| |coverage| |docs| |pypi_version| |pypi_pyversions|
.. |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-hypernode.com/pypi/resolwe
:alt: Version on PyPI
.. |pypi_pyversions| image:: https://img.shields.io/pypi/pyversions/resolwe.svg
:target: https://pypi-hypernode.com/pypi/resolwe
:alt: Supported Python versions
.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/resolwe.svg
:target: https://pypi-hypernode.com/pypi/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_ (2.7 or 3.4+) 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 the ``psycopg2`` dependency from PyPI_ will require
having a C compiler (e.g. GCC_) as well as Python and PostgreSQL development
files installed on the system.
Note
^^^^
The preferred way to install the C compiler and Python and PostgreSQL
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``,
``python-devel``/``python3-devel`` and ``postgresql-devel`` packages.
.. _Python: https://www.python.org/
.. _PostgreSQL: http://www.postgresql.org/
.. _PyPi: https://pypi-hypernode.com/
.. _GCC: https://gcc.gnu.org/
>From PyPI_
----------
.. code::
pip install --process-dependency-links resolwe
>From source
-----------
.. code::
pip install --process-dependency-links 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 --process-dependency-links https://github.com/genialis/resolwe/archive/master.tar.gz
.. _`Resolwe's GitHub repository`: https://github.com/genialis/resolwe/
Contribute
==========
We welcome new contributors. To learn more, read Contributing_ section of our
documentation.
.. _Contributing: http://resolwe.readthedocs.io/en/latest/contributing.html
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
resolwe-1.5.0.tar.gz
(309.2 kB
view details)
Built Distribution
resolwe-1.5.0-py2.py3-none-any.whl
(158.8 kB
view details)
File details
Details for the file resolwe-1.5.0.tar.gz.
File metadata
- Download URL: resolwe-1.5.0.tar.gz
- Upload date:
- Size: 309.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 91e1e6cb36a7ec61a271146cc8648cba917b19b17e86066cd114fb703bbe10ce |
|
| MD5 | 39d60e1cbf0ac63e8bd5a934f9a1a90e |
|
| BLAKE2b-256 | 5306ba4a50979f55b7c0db15278f332493f597fb24e0be5cba6b01314c739b94 |
File details
Details for the file resolwe-1.5.0-py2.py3-none-any.whl.
File metadata
- Download URL: resolwe-1.5.0-py2.py3-none-any.whl
- Upload date:
- Size: 158.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4a27bd23d3d16ed372d9498c1f53924829b89c821166aa1ea98fd6fba228e513 |
|
| MD5 | 29cc939044e63636bdf40bdb443a24e5 |
|
| BLAKE2b-256 | a877aea363ed127067f87a54809be2ec221701d33627238d19ce07d6c9dd4e43 |
