{"id":28193,"library":"snakemake-storage-plugin-gcs","title":"Snakemake Storage Plugin GCS","description":"A Snakemake storage plugin providing read/write access to Google Cloud Storage (GCS). Version 1.1.4, compatible with Snakemake ≥7.x plugin interface. Release cadence is irregular, tied to Snakemake plugin API updates.","status":"active","version":"1.1.4","language":"python","source_language":"en","source_url":"https://github.com/snakemake/snakemake-storage-plugin-gcs","tags":["snakemake","gcs","google-cloud-storage","storage-plugin","workflow"],"install":[{"cmd":"pip install snakemake-storage-plugin-gcs","lang":"bash","label":"PyPI"}],"dependencies":[{"reason":"Core workflow manager that this plugin extends","package":"snakemake","optional":false}],"imports":[{"wrong":"from snakemake_storage_plugin_gcs import StorageProviderGCS","symbol":"StorageProviderGCS","correct":"from snakemake_storage_plugin_gcs import StorageProviderGCS"}],"quickstart":{"code":"import os\n# Set authentication (uses Application Default Credentials)\nos.environ['GOOGLE_APPLICATION_CREDENTIALS'] = '/path/to/service-account-key.json'\n# Or use implicit default credentials\n# In your Snakefile, reference files with gs:// prefix\n# Example rule:\nrule download:\n    input:\n        \"gs://my-bucket/data.txt\"\n    output:\n        \"data.txt\"\n    shell:\n        \"cp {input} {output}\"","lang":"python","description":"Basic usage: install plugin, set up GCS authentication, and use gs:// URIs in Snakemake rules. The plugin auto-detects gs:// prefixes."},"warnings":[{"fix":"Use a service account key and set GOOGLE_APPLICATION_CREDENTIALS environment variable, or use workload identity federation for long-running workflows.","message":"GCS authentication uses Application Default Credentials (ADC) by default. OAuth2 tokens from ADC may expire during long runs, causing failures.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade Snakemake to 7.x or later, or use an older storage plugin if locked to Snakemake 6.x (not available).","message":"Plugin version 1.x requires Snakemake >=7.0.0 plugin API. Not compatible with older Snakemake versions that used the legacy storage API (pre-7.0).","severity":"breaking","affected_versions":"1.0.0 and above"},{"fix":"Use gsutil or google-cloud-storage API directly for versioned access.","message":"The plugin does not support GCS object versioning or generation numbers. If you need to retrieve a specific version, you must handle it separately.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"search_vec":"'1.1.4':18 '7':22 'access':11 'api':34 'cadenc':27 'cloud':14,40 'compat':19 'gcs':4,16,37 'googl':13,39 'google-cloud-storag':38 'interfac':25 'irregular':29 'plugin':3,8,24,33,44 'provid':9 'read/write':10 'releas':26 'snakemak':1,6,21,32,36 'storag':2,7,15,41,43 'storage-plugin':42 'tie':30 'updat':35 'version':17 'workflow':45 'x':23","created_at":"2026-05-09T05:54:12.765432+00:00","updated_at":"2026-05-09T05:54:12.765432+00:00","problems":{"verify_error":"Traceback (most recent call last):\n  File \"<string>\", line 1, in <module>\n  File \"/tmp/tmp1x1ua167/venv/lib/python3.12/site-packages/snakemake_storage_plugin_gcs/__init__.py\", line 13, in <module>\n    from snakemake.exceptions import WorkflowError, CheckSumMismatchException\nModuleNotFoundError: No m"},"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/snakemake/snakemake-storage-plugin-gcs","docs":"https://snakemake.github.io/snakemake-plugin-catalog/plugins/storage/gcs.html","changelog":null,"pypi":"https://pypi.org/project/snakemake-storage-plugin-gcs/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["gcp","data","workflow"],"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}}