diff --git a/.github/workflows/py-ci.yml b/.github/workflows/py-ci.yml index 071e7c6350c..0b6e751570d 100644 --- a/.github/workflows/py-ci.yml +++ b/.github/workflows/py-ci.yml @@ -73,6 +73,8 @@ jobs: python-version: '3.11' - name: install poetry run: python -m pip install poetry + - name: install current version of quilt + run: python -m pip install api/python - name: install deps run: cd testdocs && poetry install - name: test codeblocks diff --git a/api/python/quilt3/hooks.py b/api/python/quilt3/hooks.py index cb678d53a25..11949510b1c 100644 --- a/api/python/quilt3/hooks.py +++ b/api/python/quilt3/hooks.py @@ -31,6 +31,8 @@ def set_build_s3_client_hook(hook: T.Optional[BuildClientHook]) -> T.Optional[Bu Example for overriding `ServerSideEncryption` parameter for certain S3 operations: ```python + from quilt3.hooks import set_build_s3_client_hook + def event_handler(params, **kwargs): # Be mindful with parameters you set here. # Specifically it's not recommended to override/delete already set parameters @@ -48,6 +50,8 @@ def hook(build_client_base, session, client_kwargs, **kwargs): ): client.meta.events.register(f"before-parameter-build.s3.{op}", event_handler) return client + + old_hook = set_build_s3_client_hook(hook) ``` Args: diff --git a/docs/api-reference/Hooks.md b/docs/api-reference/Hooks.md index 4c99d2819d4..2181215a7e7 100644 --- a/docs/api-reference/Hooks.md +++ b/docs/api-reference/Hooks.md @@ -11,6 +11,8 @@ Set build S3 client hook. Example for overriding `ServerSideEncryption` parameter for certain S3 operations: ```python +from quilt3.hooks import set_build_s3_client_hook + def event_handler(params, **kwargs): # Be mindful with parameters you set here. # Specifically it's not recommended to override/delete already set parameters @@ -28,6 +30,8 @@ def hook(build_client_base, session, client_kwargs, **kwargs): ): client.meta.events.register(f"before-parameter-build.s3.{op}", event_handler) return client + +old_hook = set_build_s3_client_hook(hook) ``` __Arguments__