Metadata-Version: 2.1
Name: resolwe_bio
Version: 65.0.0
Summary: Bioinformatics pipelines for the Resolwe platform
Author-email: "Genialis, Inc" <dev-team@genialis.com>
License: Apache License (2.0)
Project-URL: Homepage, https://github.com/genialis/resolwe-bio
Project-URL: Documentation, https://resolwe-bio.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/genialis/resolwe-bio
Keywords: bioinformatics,resolwe,bio,pipelines,dataflow,django
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
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.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <3.15,>=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Django~=5.2.8
Requires-Dist: djangorestframework~=3.16.1
Requires-Dist: django-filter~=25.2
Requires-Dist: resolwe==45.*
Requires-Dist: wrapt~=2.0.1
Provides-Extra: test
Requires-Dist: build==1.3.0; extra == "test"
Requires-Dist: black==25.11.0; extra == "test"
Requires-Dist: check-manifest; extra == "test"
Requires-Dist: colorama; extra == "test"
Requires-Dist: django-stubs>=5.2.8; extra == "test"
Requires-Dist: django-filter-stubs>=0.1.3; extra == "test"
Requires-Dist: daphne; extra == "test"
Requires-Dist: flake8>=7.3.0; extra == "test"
Requires-Dist: isort>=7.0.0; extra == "test"
Requires-Dist: mypy>=1.19.0; extra == "test"
Requires-Dist: pydocstyle~=6.3.0; extra == "test"
Requires-Dist: setuptools_scm; extra == "test"
Requires-Dist: six==1.17; extra == "test"
Requires-Dist: tblib>=3.2.2; extra == "test"
Requires-Dist: twine==6.1.0; extra == "test"
Provides-Extra: docs
Requires-Dist: daphne; extra == "docs"
Requires-Dist: Sphinx~=8.2.3; extra == "docs"
Requires-Dist: sphinx-rtd-theme==3.0.2; extra == "docs"
Requires-Dist: pyasn1>=0.6.1; extra == "docs"
Provides-Extra: package
Requires-Dist: twine; extra == "package"
Requires-Dist: wheel; extra == "package"
Requires-Dist: check-manifest; extra == "package"
Requires-Dist: setuptools_scm; extra == "package"

======================
Resolwe Bioinformatics
======================

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

.. |build| image:: https://github.com/genialis/resolwe-bio/actions/workflows/ci.yml/badge.svg?branch=master
    :target: https://github.com/genialis/resolwe-bio/actions?query=branch%3Amaster
    :alt: Build Status

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

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

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

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

.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/resolwe-bio.svg
    :target: https://pypi.python.org/pypi/resolwe-bio
    :alt: Number of downloads from PyPI

Bioinformatics pipelines for the Resolwe_ dataflow package for `Django
framework`_.

.. _Resolwe: https://github.com/genialis/resolwe
.. _Django framework: https://www.djangoproject.com/


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

Read about getting started and how to write `processes` in the documentation_.

.. _documentation: http://resolwe-bio.readthedocs.io/


Install
=======

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

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

.. _Python: https://www.python.org/


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

.. code::

    pip install resolwe-bio

To install a pre-release, use:

.. code::

    pip install --pre resolwe-bio

.. _PyPi: https://pypi.python.org/


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

.. code::

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

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

.. code::

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

.. _`Resolwe Bioinformatics' GitHub repository`: https://github.com/genialis/resolwe-bio/
.. _GitHub: `Resolwe Bioinformatics' GitHub repository`_


Contribute
==========

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

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