# Snakemake Storage Plugin Azure
Azure Blob Storage plugin for snakemake. For documentation and usage instructions, see the [Snakemake Plugin Catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/storage/azure.html).
# 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
```Snakefile
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/snakemake/snakemake-storage-plugin-azure",
"name": "snakemake-storage-plugin-azure",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "snakemake, plugin, storage, azure",
"author": "Jake VanCampen",
"author_email": "jake.vancampen7@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f3/67/0ebb614be9b484917a6dd9c3bb962a54cdac287125fde757617130aa3cb4/snakemake_storage_plugin_azure-0.4.2.tar.gz",
"platform": null,
"description": "# Snakemake Storage Plugin Azure\n\nAzure Blob Storage plugin for snakemake. For documentation and usage instructions, see the [Snakemake Plugin Catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/storage/azure.html).\n\n# Testing\n\nTesting this plugin locally require the azurite storage emulator to be running locally. \nThis can be setup using the following docker run command: \n\n```\ndocker run -p 10000:10000 mcr.microsoft.com/azure-storage/azurite azurite-blob --blobHost 0.0.0.0\n```\n\nThen execute the tests: \n```\npoetry run coverage run -m pytest tests/tests.py\n```\n\n# Example\n\nThe 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\n\n```Snakefile\nrule touch:\n output: \"test.txt\"\n shell:\n \"echo 'Hello, World!' > {output}\"\n```\n\n**Command:**\n\nThe storage account and container that the output file is streamed to is specified using the default-storage-prefix.\n\n```\nsnakemake -j1 \\\n --default-storage-provider azure \\\n --default-storage-prefix \"az://container\"\n --storage-azure-account-name accountname \\\n --verbose\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Snakemake storage plugin to read and write from Azure Blob Storage",
"version": "0.4.2",
"project_urls": {
"Documentation": "https://snakemake.github.io/snakemake-plugin-catalog/plugins/storage/azure.html",
"Homepage": "https://github.com/snakemake/snakemake-storage-plugin-azure",
"Repository": "https://github.com/snakemake/snakemake-storage-plugin-azure"
},
"split_keywords": [
"snakemake",
" plugin",
" storage",
" azure"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "122efb145d754a1f9f45076394cf93e2cccfededbbd61a963147127a4545041a",
"md5": "866a9f2115b0bef54008b1843e0782fe",
"sha256": "bcbe3f40e93d2efdd9cd3e9cae93384805141f274cd147d86b3dab990002b381"
},
"downloads": -1,
"filename": "snakemake_storage_plugin_azure-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "866a9f2115b0bef54008b1843e0782fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 8182,
"upload_time": "2024-08-06T21:14:46",
"upload_time_iso_8601": "2024-08-06T21:14:46.235929Z",
"url": "https://files.pythonhosted.org/packages/12/2e/fb145d754a1f9f45076394cf93e2cccfededbbd61a963147127a4545041a/snakemake_storage_plugin_azure-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f3670ebb614be9b484917a6dd9c3bb962a54cdac287125fde757617130aa3cb4",
"md5": "8795967f5d2f53a580f3491f55c0d7f2",
"sha256": "f1b0395e466fa2f6a20247a23c240b418240dbd6eaf7a55af3b34714594891f0"
},
"downloads": -1,
"filename": "snakemake_storage_plugin_azure-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "8795967f5d2f53a580f3491f55c0d7f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 7175,
"upload_time": "2024-08-06T21:14:47",
"upload_time_iso_8601": "2024-08-06T21:14:47.879672Z",
"url": "https://files.pythonhosted.org/packages/f3/67/0ebb614be9b484917a6dd9c3bb962a54cdac287125fde757617130aa3cb4/snakemake_storage_plugin_azure-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 21:14:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "snakemake",
"github_project": "snakemake-storage-plugin-azure",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "snakemake-storage-plugin-azure"
}