{"id":22384,"library":"snakemake-storage-plugin-fs","title":"Snakemake Storage Plugin FS","description":"A Snakemake storage plugin for reading and writing from a locally mounted filesystem using rsync. Version 1.1.3 is the latest stable release, with active development and monthly releases focused on bug fixes and compatibility with Snakemake's storage plugin API.","status":"active","version":"1.1.3","language":"python","source_language":"en","source_url":"https://github.com/snakemake/snakemake-storage-plugin-fs","tags":["snakemake","storage-plugin","filesystem","rsync","workflow-management"],"install":[{"cmd":"pip install snakemake-storage-plugin-fs","lang":"bash","label":"Standard install"}],"dependencies":[{"reason":"Plugin is loaded as a Snakemake storage plugin; requires Snakemake >=7.0.0","package":"snakemake","optional":false},{"reason":"Underlying tool for file transfer; not a Python dependency but must be installed on the system","package":"rsync","optional":true}],"imports":[{"wrong":"from snakemake_storage_plugin_fs import StorageProviderFS","symbol":"StorageProviderFS","correct":"from snakemake_storage_plugin_fs import StorageProviderFS"}],"quickstart":{"code":"from snakemake_storage_plugin_fs import StorageProviderFS\n\n# Example: initialize with remote path and optional prefix\nprovider = StorageProviderFS(\n    remote_path=\"/path/to/remote\",\n    prefix=\"/local/prefix\"\n)\n\n# Example operations (normally triggered by Snakemake)\nprint(provider.list())\nprint(provider.stat(\"some_file.txt\"))","lang":"python","description":"Basic usage of the plugin to interact with a local filesystem storage. The plugin is typically used implicitly by Snakemake when a workflow references storage queries with 'fs://' prefix."},"warnings":[{"fix":"Install rsync (e.g., apt-get install rsync on Debian/Ubuntu, or brew install rsync on macOS).","message":"The plugin relies on rsync being installed on the system. Without it, file transfers will fail silently or with cryptic errors.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade to v1.0.3 or later and remove any manual calls to deprecated validation methods.","message":"As of v1.0.3, the query validation API was deprecated. Old code that used `validate_query` directly will fail. Users should rely on Snakemake's standard query handling.","severity":"deprecated","affected_versions":"<=1.0.2"},{"fix":"Ensure the 'remote' path is actually a locally mounted directory (e.g., NFS, FUSE, or local disk). For remote SSH, use a different plugin (e.g., snakemake-storage-plugin-s3, snakemake-storage-plugin-gs).","message":"The plugin does not support remote hosts via SSH or any network protocol; it only works with locally mounted filesystems. Users may mistakenly try to use it with remote paths via SSH, which will fail because rsync is called without SSH flags by default.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade to v1.1.3 or later, which explicitly passes `--links --no-perms --no-owner` to rsync to ensure symlinks are copied correctly.","message":"Symlinks are copied without preserving their targets by default in older versions. This can lead to broken symlinks in the cache.","severity":"gotcha","affected_versions":"<1.1.3"}],"env_vars":null,"search_vec":"'1.1.3':21 'activ':28 'api':44 'bug':35 'compat':38 'develop':29 'filesystem':17,49 'fix':36 'focus':33 'fs':4 'latest':24 'local':15 'manag':53 'month':31 'mount':16 'plugin':3,8,43,48 'read':10 'releas':26,32 'rsync':19,50 'snakemak':1,6,40,45 'stabl':25 'storag':2,7,42,47 'storage-plugin':46 'use':18 'version':20 'workflow':52 'workflow-manag':51 'write':12","created_at":"2026-04-27T17:04:53.430455+00:00","updated_at":"2026-04-27T17:04:53.430455+00:00","problems":{"verify_error":"Traceback (most recent call last):\n  File \"<string>\", line 1, in <module>\n  File \"/tmp/tmpf9sgpn08/venv/lib/python3.12/site-packages/snakemake_storage_plugin_fs/__init__.py\", line 18, in <module>\n    from snakemake_interface_storage_plugins.storage_object import (\n  File \"/tmp/tmpf9sgpn08/venv/lib/p"},"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"1.1.3","cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/snakemake/snakemake-storage-plugin-fs","docs":"https://snakemake.github.io/snakemake-plugin-catalog/plugins/storage/fs.html","changelog":null,"pypi":"https://pypi.org/project/snakemake-storage-plugin-fs/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["data","devops","workflow","http-networking"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"import_fail","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-07-10","install_tag":null}}