From f32bfb6af08c859a327ccc8f870f14f6b263c20c Mon Sep 17 00:00:00 2001 From: Brent Champion Date: Sat, 4 Oct 2025 16:37:25 -0400 Subject: [PATCH] chore: add environment variable for language SDK dependency --- .gitignore | 3 ++- CONTRIBUTING.md | 22 ++++++++++++++++++++++ pyproject.toml | 4 ++-- 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index d831fe6..be21c25 100644 --- a/.gitignore +++ b/.gitignore @@ -27,4 +27,5 @@ dist/ .vscode/ .kiro/ -.idea \ No newline at end of file +.idea +.env diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 708b856..3f2846e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,28 @@ information to effectively respond to your bug report or contribution. ## Dependencies Install [hatch](https://hatch.pypa.io/dev/install/). +## Local Development Setup + +### Using Local SDK Dependency +For local development, you can use a local version of the AWS Durable Execution SDK instead of the remote repository: + +1. Set the environment variable to point to your local SDK: + ```bash + export AWS_DURABLE_SDK_URL="file:///path/to/your/local/aws-durable-execution-sdk-python" + ``` + +2. Or create a `.env` file (already gitignored): + ```bash + echo 'AWS_DURABLE_SDK_URL=file:///path/to/your/local/aws-durable-execution-sdk-python' > .env + ``` + +3. Create the hatch environment: + ```bash + hatch env create + ``` + +Without the environment variable, the project defaults to using the SSH repository URL. + ## Developer workflow These are all the checks you would typically do as you prepare a PR: ``` diff --git a/pyproject.toml b/pyproject.toml index f2ad503..b28d4a0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,7 +21,7 @@ classifiers = [ dependencies = [ "boto3>=1.40.30", "requests>=2.25.0", - "aws_durable_execution_sdk_python @ git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git", + "aws_durable_execution_sdk_python @ {env:AWS_DURABLE_SDK_URL:git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git}", ] [project.urls] @@ -56,7 +56,7 @@ dependencies = [ "pytest", "pytest-cov", "ruff", - "aws_durable_execution_sdk_python @ git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git", + "aws_durable_execution_sdk_python @ {env:AWS_DURABLE_SDK_URL:git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git}", ] [tool.hatch.envs.test.scripts]