Snakemake Utility functions for easier working with snakemake
When debugging a script that uses snakemake to define its inputs, it is often difficult to manually set some example inputs for testing. This utility allows to directly obtain a Snakemake object from the pipeline by specifying the desired rule and wildcards.
Loading snakemake object without actually running snakemake
For obtaining a Snakemake object in python, simply paste the following preamble in your script and adjust snakefile_path, rule_name and default_wildcards.
try:
snakemake
except NameError:
import os
from snakemk_util import load_rule_args, pretty_print_snakemake
snakefile_path = os.getcwd() + "/Snakefile"
snakemake = load_rule_args(
snakefile = snakefile_path,
rule_name = 'create_prediction_target',
default_wildcards={
'ds_dir': 'all_data'
}
)
print(pretty_print_snakemake(snakemake))
Output:
Snakemake({
"threads": 64,
"resources": {
"_cores": 64,
"_nodes": 1,
"tmpdir": "<function DefaultResources.__init__.<locals>.fallback.<locals>.callable at 0x154022f799d0>",
"ntasks": 1,
"mem_mb": 250000
},
"input": {
"0": "some_input.csv"
"config": "some_config.yaml",
},
"params": {
"nb_script": "create_prediction_target.py"
},
"output": {
[...]
},
"wildcards": {
"ds_dir": "all_data"
},
"log": [],
"config": {
[...]
},
"rule": "create_prediction_target"
})
- The preamble has no effect during
snakemakeruns, so it can be kept in the script permanently. pretty_print_snakemakeknows about theNamedListthat snakemake uses and prints all non-named parameters by their index
Here the corresponding snippet for R:
if (! exists("snakemake")) {
snakefile = "Snakefile"
rule = "create_prediction_target"
python = "/opt/anaconda/envs/snakemake/bin/python"
wildcards = c(
# "comparison=all",
)
cmd=c(
"-m snakemk_util.main",
"--rule", rule,
"--snakefile", normalizePath(snakefile),
"--root_dir", dirname(normalizePath(snakefile)),
"--gen-preamble", "RScript",
"--create_dirs",
if (length(wildcards) > 0) c("--wildcards", wildcards) else NULL
)
eval(parse(text=system2(python, cmd, stdout=TRUE, stderr="")))
}
Inspecting the rule parameters on the command line
snakemk_util also provides a command-line interface which allows to display the snakemake objects for some rule and wildcard as well as generating script preambles for different languages:
# snakemk_util --help
usage: snakemk_util [-h] --rule RULE_NAME [--gen-preamble FLAVOR] [--snakefile SNAKEFILE] [--root_dir ROOT_DIR] [--wildcards [KEY=VALUE ...]] [--create_dirs]
Utility to sow Snakemake rule contents and creating script preambles without actually running Snakemake.
optional arguments:
-h, --help show this help message and exit
--rule RULE_NAME Name of the rule that should be formatted
--gen-preamble FLAVOR
Script language for which the preamble should be generated Examples: 'BashScript', 'JuliaScript', 'PythonScript', 'RMarkdown', 'RScript', 'RustScript', 'PythonJupyterNotebook', 'RJupyterNotebook'
--snakefile SNAKEFILE
path to the Snakefile
--root_dir ROOT_DIR Root directory from where you would run the `snakemake` command. By default, this is the current working directory.
--wildcards [KEY=VALUE ...]
Wildcards used to format the rule output, given as space-separated 'key=value' tokens. Example: --wildcards wildcard0=x wildcard1=y
--create_dirs Create the output directories for the rule
Installation
pip install snakemk_util
Metadata
Release files for snakemk-util 3.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| snakemk_util-3.0.1.tar.gz | 120.1 kB | With provenance | Details for snakemk_util-3.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| snakemk_util-3.0.1-py3-none-any.whl | Python 3 | none | any | Details for snakemk_util-3.0.1-py3-none-any.whl |
Total release size: 129.5 kB
Release files / snakemk_util-3.0.1.tar.gz
| Download URL | snakemk_util-3.0.1.tar.gz |
|---|---|
| Size | 120.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8416b753e959b5e6cf0b2b59cd4b09834c9a2dc55c97f9b60fdc8909dc1ee4e8
|
|
BLAKE2b-256 checksum How to use checksums |
1d35e9606c213579da0c94985393d5647039f22f83137f8a02443472face8d88
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 9, 2026.
Transparency logRelease files / snakemk_util-3.0.1-py3-none-any.whl
| Download URL | snakemk_util-3.0.1-py3-none-any.whl |
|---|---|
| Size | 9.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1fc865c42b1829fa9dd26379bd186c30bc2e86e4e5f18e3bad29276595591d66
|
|
BLAKE2b-256 checksum How to use checksums |
67dec624a7859e12b6122afc97968d510dc916bd1437579fb1a46333ae703c0a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 9, 2026.
Transparency logSecurity for snakemk-util 3.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for snakemk_util-3.0.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.