=======
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
Raw data
{
"_id": null,
"home_page": null,
"name": "resolwe",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "resolwe, dataflow, django",
"author": null,
"author_email": "\"Genialis, Inc\" <dev-team@genialis.com>",
"download_url": "https://files.pythonhosted.org/packages/03/a1/ad6e5ae8c91b63944280718bdbb08ad162dc02eb1cf64dfde3e1d6dafefa/resolwe-42.2.0.tar.gz",
"platform": null,
"description": "=======\nResolwe\n=======\n\n|build| |coverage| |docs| |black| |pypi_version| |pypi_pyversions| |pypi_downloads|\n\n.. |build| image:: https://github.com/genialis/resolwe/workflows/Resolwe%20CI/badge.svg?branch=master\n :target: https://github.com/genialis/resolwe/actions?query=branch%3Amaster\n :alt: Build Status\n\n.. |coverage| image:: https://img.shields.io/codecov/c/github/genialis/resolwe/master.svg\n :target: http://codecov.io/github/genialis/resolwe?branch=master\n :alt: Coverage Status\n\n.. |docs| image:: https://readthedocs.org/projects/resolwe/badge/?version=latest\n :target: http://resolwe.readthedocs.io/\n :alt: Documentation Status\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style Black\n\n.. |pypi_version| image:: https://img.shields.io/pypi/v/resolwe.svg\n :target: https://pypi.org/project/resolwe\n :alt: Version on PyPI\n\n.. |pypi_pyversions| image:: https://img.shields.io/pypi/pyversions/resolwe.svg\n :target: https://pypi.org/project/resolwe\n :alt: Supported Python versions\n\n.. |pypi_downloads| image:: https://pepy.tech/badge/resolwe\n :target: https://pepy.tech/project/resolwe\n :alt: Number of downloads from PyPI\n\nResolwe is an open source dataflow package for `Django framework`_. We envision\nResolwe to follow the `Common Workflow Language`_ specification, but the\ncurrent implementation does not yet fully support it. Resolwe offers a complete\nRESTful API to connect with external resources. A collection of bioinformatics\npipelines is available in `Resolwe Bioinformatics`_.\n\n.. _Django framework: https://www.djangoproject.com/\n.. _Common Workflow Language: https://github.com/common-workflow-language/common-workflow-language\n.. _Resolwe Bioinformatics: https://github.com/genialis/resolwe-bio\n\n\nDocs & Help\n===========\n\nRead about architecture, getting started, how to write `processes`, RESTful API\ndetails, and API Reference in the documentation_.\n\nTo chat with developers or ask for help, join us on Slack_.\n\n.. _documentation: http://resolwe.readthedocs.io/\n.. _Slack: http://resolwe.slack.com/\n\n\nInstall\n=======\n\nPrerequisites\n-------------\n\nResolwe runs on Python_ 3.6 or later If you don't have it yet, follow `these\ninstructions <https://docs.python.org/3/using/index.html>`__.\n\nIt's easiest to run other required services in Docker containers If you don't\nhave it yet, you can follow the `official Docker tutorial`_ for Mac and for\nWindows or install it as a distribution's package in most of standard Linux\ndistributions (Fedora, Ubuntu,...).\n\n.. _Python: https://www.python.org/\n.. _official Docker tutorial: https://docs.docker.com/get-started/\n\nUsing PyPI_\n-----------\n\n.. code::\n\n pip install resolwe\n\n.. _PyPI: https://pypi.org/\n\nUsing source on GitHub_\n-----------------------\n\n.. code::\n\n pip install https://github.com/genialis/resolwe/archive/<git-tree-ish>.tar.gz\n\nwhere ``<git-tree-ish>`` can represent any commit SHA, branch name, tag name,\netc. in `Resolwe's GitHub repository`_. For example, to install the latest\nResolwe from the ``master`` branch, use:\n\n.. code::\n\n pip install https://github.com/genialis/resolwe/archive/master.tar.gz\n\n.. _`Resolwe's GitHub repository`: https://github.com/genialis/resolwe/\n.. _GitHub: `Resolwe's GitHub repository`_\n\n\nContribute\n==========\n\nWe welcome new contributors. To learn more, read Contributing_ section of our\ndocumentation.\n\n.. _Contributing: http://resolwe.readthedocs.io/en/latest/contributing.html\n",
"bugtrack_url": null,
"license": "Apache License (2.0)",
"summary": "Open source enterprise dataflow engine in Django",
"version": "42.2.0",
"project_urls": {
"Documentation": "https://resolwe.readthedocs.io/en/latest/",
"Homepage": "https://github.com/genialis/resolwe/",
"Repository": "https://github.com/genialis/resolwe/"
},
"split_keywords": [
"resolwe",
" dataflow",
" django"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d0288ab686f5900cf8b75bce4035309c5620d8ca7b68dd8c1abba17d3d9c971",
"md5": "59ee74292cc7872086e67858c4f71d93",
"sha256": "875c13bf3ca3f2393a19b89927e89961b6eee08a1e344104f9519b3f4016ef96"
},
"downloads": -1,
"filename": "resolwe-42.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59ee74292cc7872086e67858c4f71d93",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 662473,
"upload_time": "2025-01-13T10:50:07",
"upload_time_iso_8601": "2025-01-13T10:50:07.880530Z",
"url": "https://files.pythonhosted.org/packages/4d/02/88ab686f5900cf8b75bce4035309c5620d8ca7b68dd8c1abba17d3d9c971/resolwe-42.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03a1ad6e5ae8c91b63944280718bdbb08ad162dc02eb1cf64dfde3e1d6dafefa",
"md5": "254279f182562ab1be48d305af5c8915",
"sha256": "b92b352dcc31b814f3737d183ed938478a3110392d6c6c3f4e050317049d09c3"
},
"downloads": -1,
"filename": "resolwe-42.2.0.tar.gz",
"has_sig": false,
"md5_digest": "254279f182562ab1be48d305af5c8915",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 682747,
"upload_time": "2025-01-13T10:50:11",
"upload_time_iso_8601": "2025-01-13T10:50:11.174432Z",
"url": "https://files.pythonhosted.org/packages/03/a1/ad6e5ae8c91b63944280718bdbb08ad162dc02eb1cf64dfde3e1d6dafefa/resolwe-42.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 10:50:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "genialis",
"github_project": "resolwe",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "resolwe"
}
JSON
