CHANGELOG.md

Changelog

4.4.1 (2026-03-16)

Bug Fixes

• python 3.10 compatibility (#91) (4a7a902)

4.4.0 (2026-03-16)

Features

• add checksum to IOCacheInterface and StorageObject (#90) (90e9eb7)

Bug Fixes

• improve error messaging for disk space issues (#86) (437629d)
• use the latest time of file or link (#87) (35ba663)

4.3.3 (2026-02-20)

Bug Fixes

• add missing dependency on humanfriendly (#84) (5f641d5)

4.3.2 (2025-12-01)

Bug Fixes

• make query optional (5c3c5b6)

4.3.1 (2025-12-01)

Bug Fixes

• turn FileOrDirectoryNotFoundError into WorkflowError (c2d53bf)

4.3.0 (2025-12-01)

Features

• raise FileOrDirectoryNotFoundError if mtime or size queries fail and object does not exist remotely (#80) (e1fd75e)

4.2.3 (2025-09-10)

Bug Fixes

• test size method (#78) (d6f9a2a)

4.2.2 (2025-07-29)

Documentation

• use snakedeploy (2ef0abe)

4.2.1 (2025-03-20)

Bug Fixes

• adapt action job permissions to changes in github actions or pypi (2b553d6)

4.2.0 (2025-03-20)

Features

• Integrate Pixi for improved CI/CD and update project configuration (#64) (ff1120a)

Bug Fixes

• make ondemand eligibility determination smarter (respecting keep-local) (#72) (43738d6)

4.1.0 (2025-03-19)

Features

• introduce attribute StorageObjectBase.is_ondemand_eligible, allowing to inform the plugin about whether it can e.g. lazily mount or symlink the storage object instead of downloading/copying it (c3cee67)

4.0.1 (2025-03-18)

Bug Fixes

• use snakemake from git for testing (586f144)

4.0.0 (2025-03-18)

Miscellaneous Chores

• release 4.0.0 (12041a7)

3.6.0 (2025-03-18)

Features

• introduce waiting for enough free space on local storage; require passing the logger to the storage provider (#68) (cb80c6b)

Bug Fixes

• improve storage error messages to include any underlying errors (066664b)

3.5.0 (2025-03-14)

Features

• Allow default configuration of retrieve behaviour (#60) (a30f957)

3.4.0 (2025-03-12)

Features

• Add option to modify how a query is printed (#54) (0634a9e)

Bug Fixes

• update wildcard regex to match {wildcard.name} (#40) (19a5f80)

3.3.0 (2024-08-19)

Features

• add postprocess_query method for optionally modifying the query before a storage object is created (#51) (5590a90)

3.2.4 (2024-08-14)

Bug Fixes

• in test suite, check that filepath exists after retrieval (b4585df)

3.2.3 (2024-07-04)

Bug Fixes

• fix name of touch operation attribute (a0556bc)
• return type of local_suffix (#48) (31ef31d)

3.2.2 (2024-04-17)

Bug Fixes

• improved storage tests (#45) (74e07a0)

3.2.1 (2024-04-16)

Bug Fixes

• rm local dir before storage test (170a135)

3.2.0 (2024-04-15)

Features

• add test case for directories (#42) (e6c4294)

3.1.1 (2024-03-07)

Bug Fixes

• test mtime in test suite (#38) (5cdd759)

3.1.0 (2024-02-19)

Features

• support for touching storage objects (updating their modification time) (#35) (a7db28b)

Bug Fixes

• improved inventory test (a07d750)

3.0.0 (2023-12-05)

⚠ BREAKING CHANGES

• require list of example queries (renamed method example_query into example_queries); this way, we support storage providers that need multiple examples to best explain how queries are structured

Features

• require list of example queries (renamed method example_query into example_queries); this way, we support storage providers that need multiple examples to best explain how queries are structured (a2c4a70)
• support checking whether plugin is read/write. (df1f4da)

2.1.1 (2023-11-26)

Bug Fixes

• fix property name in interface (89b48d5)

2.1.0 (2023-11-23)

Features

• add argument for stripping incomplete parts of constant prefix (d050377)

Bug Fixes

• raise WorkflowError in case of failture during dir creation (ed38962)
• remove superfluous method (30aeb9e)

2.0.1 (2023-11-15)

Miscellaneous Chores

• release 2.0.1 (c0e9d30)

2.0.0 (2023-11-15)

⚠ BREAKING CHANGES

• add tmp_path to query methods in test suite

Features

• add tmp_path to query methods in test suite (5cfcf62)

Bug Fixes

• IOCache call in test suite (00abf1b)

Documentation

• update readme (63b5a4b)

1.3.1 (2023-11-15)

Bug Fixes

• create local storage prefix if it is not yet present (ec5ff76)

1.3.0 (2023-11-15)

Features

• add cache_key method (2b571d0)

1.2.3 (2023-10-24)

Bug Fixes

• adapt test suite to changes in snakemake 8 (a4cbefa)

1.2.2 (2023-10-24)

Bug Fixes

• fix release process (ec96bd2)

1.2.1 (2023-10-24)

Bug Fixes

• update dependencies (96df30e)

1.2.0 (2023-10-17)

Features

• migrate flagging code into main snakemake (974f05d)

Bug Fixes

• add homepage (b9846e0)

1.1.2 (2023-10-13)

Bug Fixes

• fix testcase for writable storage provider (32f473a)
• remove superfluous dependency (12b9061)

1.1.1 (2023-10-11)

Bug Fixes

• fix testcase for writable storage provider (32f473a)
• update deps (856ba18)

1.1.0 (2023-10-11)

Features

• extend test cases (6b49597)
• require example query to be provided (f48b3f0)

Bug Fixes

• adapt to changes in snakemake-interface-common (a7da931)
• update deps (856ba18)

1.0.2 (2023-09-28)

Bug Fixes

• remove object after test (b55c77c)

1.0.1 (2023-09-27)

Bug Fixes

• improved API (1a5d518)

1.0.0 (2023-09-27)

Miscellaneous Chores

• release 1.0.0 (522f4b6)

0.1.0 (2023-09-26)

Features

• add retry decorator (30bcaf3)
• cleaned up and simplified API (243177e)
• support tagged settings (1a64b4f)

Bug Fixes

• bump min version of snakemake-interface-common (c50c9c1)