Skip to content

Commit bfe25ec

Browse files
authored
Improve set-up instructions for examples (#534)
* Add pip install line for processes example set up instructions * Add lithops-aws and lithops-gcp extras
1 parent 819f6c8 commit bfe25ec

File tree

4 files changed

+13
-3
lines changed

4 files changed

+13
-3
lines changed

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Follow the instructions for setting up Cubed to run on your executor runtime:
2323

2424
| Executor | Cloud | Set up instructions |
2525
|-----------|--------|------------------------------------------------|
26-
| Processes | N/A | N/A |
26+
| Processes | N/A | `pip install 'cubed[diagnostics]'` |
2727
| Lithops | AWS | [lithops/aws/README.md](lithops/aws/README.md) |
2828
| | Google | [lithops/gcp/README.md](lithops/gcp/README.md) |
2929
| Modal | AWS | [modal/aws/README.md](modal/aws/README.md) |

examples/lithops/aws/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
```shell
1313
conda create --name cubed-lithops-aws-examples -y python=3.11
1414
conda activate cubed-lithops-aws-examples
15-
pip install -r requirements.txt # use requirements file from same directory as this readme
15+
pip install 'cubed[lithops-aws]'
1616
```
1717

1818
2. Configure Lithops with an [AWS Lambda compute backend](https://lithops-cloud.github.io/docs/source/compute_config/aws_lambda.html), and an [AWS S3 storage backend](https://lithops-cloud.github.io/docs/source/storage_config/aws_s3.html).

examples/lithops/gcp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# from this directory
1313
conda create --name cubed-lithops-gcp-examples -y python=3.11
1414
conda activate cubed-lithops-gcp-examples
15-
pip install -r requirements.txt # use requirements file from same directory as this readme
15+
pip install 'cubed[lithops-gcp]'
1616
```
1717

1818
2. Configure Lithops with a [Google Cloud Functions compute backend](https://lithops-cloud.github.io/docs/source/compute_config/gcp_functions.html#configuration), and a [Google Cloud Storage backend](https://lithops-cloud.github.io/docs/source/storage_config/gcp_storage.html#configuration).

pyproject.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,16 @@ beam = ["apache-beam", "gcsfs"]
5454
dask = ["dask"]
5555
dask-distributed = ["distributed"]
5656
lithops = ["lithops[aws] >= 2.7.0"]
57+
lithops-aws = [
58+
"cubed[diagnostics]",
59+
"lithops[aws]",
60+
"s3fs",
61+
]
62+
lithops-gcp = [
63+
"cubed[diagnostics]",
64+
"lithops[gcp]",
65+
"gcsfs",
66+
]
5767
modal = [
5868
"cubed[diagnostics]",
5969
"modal-client",

0 commit comments

Comments
 (0)