A Snakemake storage plugin to read and write from Azure Blob Storage

These details have not been verified by PyPI

Project links

Project description

Snakemake Storage Plugin Azure

Azure Blob Storage plugin for snakemake. For documentation and usage instructions, see the Snakemake Plugin Catalog.

Testing

Testing this plugin locally require the azurite storage emulator to be running locally. This can be setup using the following docker run command:

docker run -p 10000:10000 mcr.microsoft.com/azure-storage/azurite azurite-blob --blobHost 0.0.0.0

Then execute the tests:

poetry run coverage run -m pytest tests/tests.py

Example

The below example Snakefile and command will stream a file, test.txt, containing the text "Hello, World" to the azure blob: https://accountname.blob.core.windows.net/container/test.txt

rule touch:
    output: "test.txt"
    shell:
        "echo 'Hello, World!' > {output}"

Command:

The storage account and container that the output file is streamed to is specified using the default-storage-prefix.

snakemake -j1 \
    --default-storage-provider azure \
    --default-storage-prefix "az://container"
    --storage-azure-account-name accountname \
    --verbose

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

0.4.2

Aug 6, 2024

0.4.1

Aug 5, 2024

0.4.0

Aug 4, 2024

0.3.0

Jul 28, 2024

0.2.2

Jul 20, 2024

0.2.1

Jul 18, 2024

0.2.0

Jul 18, 2024

0.1.6

Jul 13, 2024

0.1.5

Mar 6, 2024

0.1.4

Dec 19, 2023

0.1.3

Dec 12, 2023

0.1.2

Dec 5, 2023

0.1.1

Dec 1, 2023

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snakemake_storage_plugin_azure-0.4.2.tar.gz (7.2 kB view details)

Uploaded Aug 6, 2024 Source

Built Distribution

snakemake_storage_plugin_azure-0.4.2-py3-none-any.whl (8.2 kB view details)

Uploaded Aug 6, 2024 Python 3

File details

Details for the file snakemake_storage_plugin_azure-0.4.2.tar.gz.

File metadata

Download URL: snakemake_storage_plugin_azure-0.4.2.tar.gz
Upload date: Aug 6, 2024
Size: 7.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for snakemake_storage_plugin_azure-0.4.2.tar.gz
Algorithm	Hash digest
SHA256	`f1b0395e466fa2f6a20247a23c240b418240dbd6eaf7a55af3b34714594891f0`
MD5	`8795967f5d2f53a580f3491f55c0d7f2`
BLAKE2b-256	`f3670ebb614be9b484917a6dd9c3bb962a54cdac287125fde757617130aa3cb4`

See more details on using hashes here.

Provenance

File details

Details for the file snakemake_storage_plugin_azure-0.4.2-py3-none-any.whl.

File metadata

Download URL: snakemake_storage_plugin_azure-0.4.2-py3-none-any.whl
Upload date: Aug 6, 2024
Size: 8.2 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for snakemake_storage_plugin_azure-0.4.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`bcbe3f40e93d2efdd9cd3e9cae93384805141f274cd147d86b3dab990002b381`
MD5	`866a9f2115b0bef54008b1843e0782fe`
BLAKE2b-256	`122efb145d754a1f9f45076394cf93e2cccfededbbd61a963147127a4545041a`