Skip to content

chore: add environment variable for language SDK dependency #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bchampp merged 1 commit into from
Oct 4, 2025
Merged

chore: add environment variable for language SDK dependency #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,5 @@ dist/

.vscode/
.kiro/
.idea
.idea
.env
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down