Metadata-Version: 2.1
Name: virtool-workflow
Version: 7.1.1
Summary: A framework for developing bioinformatics workflows for Virtool.
Home-page: https://github.com/virtool/virtool-workflow
License: MIT
Author: Ian Boyes
Maintainer: Ian Boyes
Requires-Python: >=3.12,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aiofiles (>=0.7.0,<0.8.0)
Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
Requires-Dist: biopython (>=1.81,<2.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: orjson (>=3.9.9,<4.0.0)
Requires-Dist: pydantic-factories (>=1.17.3,<2.0.0)
Requires-Dist: pyfixtures (>=1.0.0,<2.0.0)
Requires-Dist: sentry-sdk (>=2.3.1,<3.0.0)
Requires-Dist: virtool-core (>=14.0.0,<15.0.0)
Project-URL: Repository, https://github.com/virtool/virtool-workflow
Description-Content-Type: text/markdown

# Virtool Workflow

![Tests](https://github.com/virtool/virtool-workflow/workflows/ci/badge.svg?branch=main)
[![PyPI version](https://badge.fury.io/py/virtool-workflow.svg)](https://badge.fury.io/py/virtool-workflow)

A framework for developing bioinformatic workflows in Python.

```python
from virtool_workflow import step


@step
def step_function():
    ...


@step
def step_function_2():
    ...
```

## Contributing

### Commits

We require specific commit formatting. Any commit that does not follow the guidelines
will be squashed at our discretion.

Read our [commit and release](https://dev.virtool.ca/en/latest/commits_releases.html)
documentation for more information.

### Tests

Run tests with:

```shell
# Bring up Redis and the test container.
docker compose up -d

# Run tests in the test container.
docker compose exec test poetry run pytest

```

Run specific tests like:

```shell
docker compose exec test poetry run pytest tests/test_status.py
```

