Skip to content

Commit b8eb7ba

Browse files
authored
chore: add environment variable for language SDK dependency (#12)
1 parent 22a37fc commit b8eb7ba

3 files changed

Lines changed: 26 additions & 3 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,5 @@ dist/
2727

2828
.vscode/
2929
.kiro/
30-
.idea
30+
.idea
31+
.env

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,28 @@ information to effectively respond to your bug report or contribution.
99
## Dependencies
1010
Install [hatch](https://hatch.pypa.io/dev/install/).
1111

12+
## Local Development Setup
13+
14+
### Using Local SDK Dependency
15+
For local development, you can use a local version of the AWS Durable Execution SDK instead of the remote repository:
16+
17+
1. Set the environment variable to point to your local SDK:
18+
```bash
19+
export AWS_DURABLE_SDK_URL="file:///path/to/your/local/aws-durable-execution-sdk-python"
20+
```
21+
22+
2. Or create a `.env` file (already gitignored):
23+
```bash
24+
echo 'AWS_DURABLE_SDK_URL=file:///path/to/your/local/aws-durable-execution-sdk-python' > .env
25+
```
26+
27+
3. Create the hatch environment:
28+
```bash
29+
hatch env create
30+
```
31+
32+
Without the environment variable, the project defaults to using the SSH repository URL.
33+
1234
## Developer workflow
1335
These are all the checks you would typically do as you prepare a PR:
1436
```

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ classifiers = [
2121
dependencies = [
2222
"boto3>=1.40.30",
2323
"requests>=2.25.0",
24-
"aws_durable_execution_sdk_python @ git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git",
24+
"aws_durable_execution_sdk_python @ {env:AWS_DURABLE_SDK_URL:git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git}",
2525
]
2626

2727
[project.urls]
@@ -56,7 +56,7 @@ dependencies = [
5656
"pytest",
5757
"pytest-cov",
5858
"ruff",
59-
"aws_durable_execution_sdk_python @ git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git",
59+
"aws_durable_execution_sdk_python @ {env:AWS_DURABLE_SDK_URL:git+ssh://git@github.com/aws/aws-durable-execution-sdk-python.git}",
6060
]
6161

6262
[tool.hatch.envs.test.scripts]

0 commit comments

Comments
 (0)