Metadata-Version: 2.4
Name: snakemake-software-deployment-plugin-container
Version: 0.6.0
Project-URL: repository, https://github.com/snakemake/snakemake-software-deployment-plugin-container
Project-URL: documentation, https://snakemake.github.io/snakemake-plugin-catalog/plugins/software-deployment/container.html
Author-email: Ben Carrillo <ben.uzh@pm.me>, Johannes Köster <johannes.koester@uni-due.de>
License-File: LICENSE
Requires-Python: <4.0,>=3.11
Requires-Dist: snakemake-interface-common<2.0.0,>=1.23.0
Requires-Dist: snakemake-interface-software-deployment-plugins<1.0,>=0.16.0
Requires-Dist: udocker<2.0.0,>=1.3.17
Description-Content-Type: text/markdown

# snakemake-software-deployment-plugin-container

A generic container plugin implementing snakemake's software-deployment interface.

* It executes the given commands within a rootless container.
* It currently supports both `udocker` and  `podman`.

## Usage

The `kind` parameter specifies valid values for the container runtime to use.

The `container` directive (should be) used to specify the container image to use
for the software deployment. This string should be a valid container image name,
including the tag; e.g., `biocontainers/example:1.0`.

By default, the plugin will attemtp to use 'latest' tag if no tag is provided.
However, be aware that some registries may not support this, for [good
reasons](https://github.com/BioContainers/containers/issues/297#issuecomment-439055879)
having to do with reproducibility. So, it's a good idea to specify a tag.

## Status

- Work in progress. The plugin conforms to the current software-deployment interface specification, and it has passing tests.
- Will revisit when further work is done in snakemake core to allow a more reusable integration of deployment plugins.

## TODO

- [ ] Add support for apptainer
- [ ] Implement repot_sofware method with container URI *and* the resolved hash of the image.
