From bfe25ec384307afa72381e986f6edb99809d76c3 Mon Sep 17 00:00:00 2001 From: Tom White Date: Sun, 4 Aug 2024 09:40:37 +0100 Subject: [PATCH] Improve set-up instructions for examples (#534) * Add pip install line for processes example set up instructions * Add lithops-aws and lithops-gcp extras --- examples/README.md | 2 +- examples/lithops/aws/README.md | 2 +- examples/lithops/gcp/README.md | 2 +- pyproject.toml | 10 ++++++++++ 4 files changed, 13 insertions(+), 3 deletions(-) diff --git a/examples/README.md b/examples/README.md index fb45940a..ce3560a4 100644 --- a/examples/README.md +++ b/examples/README.md @@ -23,7 +23,7 @@ Follow the instructions for setting up Cubed to run on your executor runtime: | Executor | Cloud | Set up instructions | |-----------|--------|------------------------------------------------| -| Processes | N/A | N/A | +| Processes | N/A | `pip install 'cubed[diagnostics]'` | | Lithops | AWS | [lithops/aws/README.md](lithops/aws/README.md) | | | Google | [lithops/gcp/README.md](lithops/gcp/README.md) | | Modal | AWS | [modal/aws/README.md](modal/aws/README.md) | diff --git a/examples/lithops/aws/README.md b/examples/lithops/aws/README.md index 1a273669..7de189b5 100644 --- a/examples/lithops/aws/README.md +++ b/examples/lithops/aws/README.md @@ -12,7 +12,7 @@ ```shell conda create --name cubed-lithops-aws-examples -y python=3.11 conda activate cubed-lithops-aws-examples -pip install -r requirements.txt # use requirements file from same directory as this readme +pip install 'cubed[lithops-aws]' ``` 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). diff --git a/examples/lithops/gcp/README.md b/examples/lithops/gcp/README.md index fd7a4115..ef76cded 100644 --- a/examples/lithops/gcp/README.md +++ b/examples/lithops/gcp/README.md @@ -12,7 +12,7 @@ # from this directory conda create --name cubed-lithops-gcp-examples -y python=3.11 conda activate cubed-lithops-gcp-examples -pip install -r requirements.txt # use requirements file from same directory as this readme +pip install 'cubed[lithops-gcp]' ``` 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). diff --git a/pyproject.toml b/pyproject.toml index 97e1be3c..dad68184 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,6 +54,16 @@ beam = ["apache-beam", "gcsfs"] dask = ["dask"] dask-distributed = ["distributed"] lithops = ["lithops[aws] >= 2.7.0"] +lithops-aws = [ + "cubed[diagnostics]", + "lithops[aws]", + "s3fs", +] +lithops-gcp = [ + "cubed[diagnostics]", + "lithops[gcp]", + "gcsfs", +] modal = [ "cubed[diagnostics]", "modal-client",