From a718724aa6334a136a479b591d281bdbb9b8bb61 Mon Sep 17 00:00:00 2001 From: carole-lavillonniere Date: Thu, 8 Oct 2026 14:17:57 +0200 Subject: [PATCH] Replace git URL installs with PyPI installs and remove install badges --- README.md | 10 ++-------- diagnosis-viewer/README.md | 2 -- hello-world/README.md | 2 -- httpbin/README.md | 2 -- keycloak/README.md | 2 +- mailhog/README.md | 10 ---------- miniflare/README.md | 4 +--- mockoon/README.md | 6 +++--- paradedb/README.md | 6 ++---- prometheus/README.md | 2 -- stripe/README.md | 2 -- template/{{cookiecutter.project_slug}}/README.md | 6 +++--- .../basic/{{cookiecutter.project_slug}}/README.md | 6 +++--- .../react/{{cookiecutter.project_slug}}/README.md | 6 +++--- terraform-init/README.md | 6 ++---- typedb/README.md | 6 ++---- utils/README.md | 9 --------- wiremock/README.md | 6 ++---- 18 files changed, 24 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 6f868450..b7c1dbc4 100644 --- a/README.md +++ b/README.md @@ -47,19 +47,13 @@ Commands: ``` To install an extension, specify the name of the pip dependency that contains -the extension. For example, for the official Stripe extension, you can either -use the package distributed on pypi: +the extension. For example, for the official httpbin extension, use the package +distributed on PyPI: ```console $ localstack extensions install localstack-extension-httpbin ``` -or you can install the latest version directly from this Git repository - -```console -$ localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-httpbin&subdirectory=httpbin" -``` - ## Official LocalStack Extensions Here is the current list of extensions developed by the LocalStack team and their support status. diff --git a/diagnosis-viewer/README.md b/diagnosis-viewer/README.md index 195a141d..e6ed25ee 100644 --- a/diagnosis-viewer/README.md +++ b/diagnosis-viewer/README.md @@ -1,7 +1,5 @@ Diagnosis Viewer =============================== -[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-diagnosis-viewer&subdirectory=diagnosis-viewer) - View the diagnostics endpoint directly in localstack ## Access Diagnosis Data diff --git a/hello-world/README.md b/hello-world/README.md index 70bd7a17..c660a0c5 100644 --- a/hello-world/README.md +++ b/hello-world/README.md @@ -1,7 +1,5 @@ Hello World LocalStack extension ================================ -[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-hello-world&subdirectory=hello-world) - A minimal LocalStack extension. ## What does it do? diff --git a/httpbin/README.md b/httpbin/README.md index 085dcc86..52120597 100644 --- a/httpbin/README.md +++ b/httpbin/README.md @@ -1,7 +1,5 @@ LocalStack httpbin extension =============================== -[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-httpbin&subdirectory=httpbin) - A simple HTTP Request & Response Service directly in LocalStack using [httpbin](https://github.com/postmanlabs/httpbin). Get the full httpbin experience directly in LocalStack without connecting to httpbin.org! diff --git a/keycloak/README.md b/keycloak/README.md index 2c1659bc..bca1479d 100644 --- a/keycloak/README.md +++ b/keycloak/README.md @@ -19,7 +19,7 @@ This Extension: ## Installation ```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-keycloak&subdirectory=keycloak" +localstack extensions install localstack-keycloak ``` ## Install local development version diff --git a/mailhog/README.md b/mailhog/README.md index 226c4fec..36adb93e 100644 --- a/mailhog/README.md +++ b/mailhog/README.md @@ -1,7 +1,5 @@ LocalStack Mailhog Extension =============================== -[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-mailhog&subdirectory=mailhog) - Web and API based SMTP testing directly in LocalStack using [MailHog](https://github.com/mailhog/MailHog). If the standard configuration is used, LocalStack will serve the UI through http://mailhog.localhost.localstack.cloud:4566 or http://localhost:4566/mailhog/. @@ -22,14 +20,6 @@ After starting LocalStack, you should see these lines in the log: 2023-07-26T10:00:08.072 INFO --- [ MainThread] mailhog.extension : serving mailhog extension on path: http://localhost:4566/mailhog/ ``` -## Install from GitHub repository - -Alternatively, you can install the latest unreleased version directly from the GitHub repository by running: - -```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-mailhog-extension&subdirectory=mailhog" -``` - ## Integration with LocalStack When using this extension, LocalStack is automatically configured to use the MailHog SMTP server when sending emails. diff --git a/miniflare/README.md b/miniflare/README.md index fcb73e92..e680b076 100644 --- a/miniflare/README.md +++ b/miniflare/README.md @@ -1,7 +1,5 @@ Miniflare LocalStack extension (experimental) ============================================= -[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-miniflare&subdirectory=miniflare) - This extension makes [Miniflare](https://miniflare.dev) (dev environment for Cloudflare workers) available directly in LocalStack! ⚠️ Please note that this extension is experimental and currently under active development. @@ -9,7 +7,7 @@ This extension makes [Miniflare](https://miniflare.dev) (dev environment for Clo ## Installing ```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-miniflare&subdirectory=miniflare" +localstack extensions install localstack-extension-miniflare ``` ## How to use diff --git a/mockoon/README.md b/mockoon/README.md index 1ec267c2..5365970e 100644 --- a/mockoon/README.md +++ b/mockoon/README.md @@ -12,18 +12,18 @@ The extension runs the [Mockoon CLI](https://mockoon.com/cli/) (`mockoon/cli:9` - `make` and Terraform (for the sample app) - [Mockoon desktop app](https://mockoon.com/download/) (optional, for designing your mock APIs) -## Install from GitHub repository +## Install from PyPI `lstk` does not have commands for managing extensions, but LocalStack can install the extension at startup via the `EXTENSION_AUTO_INSTALL` config variable: ```bash -LOCALSTACK_EXTENSION_AUTO_INSTALL="git+https://github.com/localstack/localstack-extensions.git#egg=localstack-mockoon&subdirectory=mockoon" lstk start +LOCALSTACK_EXTENSION_AUTO_INSTALL="localstack-mockoon" lstk start ``` Alternatively, if you are using the legacy `localstack` CLI: ```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-mockoon&subdirectory=mockoon" +localstack extensions install localstack-mockoon ``` ## Install local development version diff --git a/paradedb/README.md b/paradedb/README.md index e07da3f9..9bfbf4e7 100644 --- a/paradedb/README.md +++ b/paradedb/README.md @@ -74,12 +74,10 @@ The following environment variables can be passed to the LocalStack container to * `localstack` CLI * `make` -## Install from GitHub repository - -This extension can be installed directly from this Github repo via: +## Install from PyPI ```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-extension-paradedb&subdirectory=paradedb" +localstack extensions install localstack-extension-paradedb ``` ## Install local development version diff --git a/prometheus/README.md b/prometheus/README.md index c1c2d6aa..83cf5872 100644 --- a/prometheus/README.md +++ b/prometheus/README.md @@ -1,6 +1,4 @@ # LocalStack Prometheus Metrics -[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-prometheus-metrics&subdirectory=prometheus) - Instruments, collects, and exposes LocalStack metrics via a [Prometheus](https://prometheus.io/) endpoint. ## Installing diff --git a/stripe/README.md b/stripe/README.md index ce382c45..96364449 100644 --- a/stripe/README.md +++ b/stripe/README.md @@ -1,7 +1,5 @@ Stripe LocalStack extensions ============================ -[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-stripe&subdirectory=stripe) - A LocalStack extension that provides a mocked version of [Stripe](https://stripe.com) as a service. ## Installing diff --git a/template/{{cookiecutter.project_slug}}/README.md b/template/{{cookiecutter.project_slug}}/README.md index 7240972b..7e20de1c 100644 --- a/template/{{cookiecutter.project_slug}}/README.md +++ b/template/{{cookiecutter.project_slug}}/README.md @@ -25,10 +25,10 @@ You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled ex EXTENSION_DEV_MODE=1 localstack start ``` -## Install from GitHub repository +## Publish to PyPI -To distribute your extension, simply upload it to your github account. Your extension can then be installed via: +To distribute your extension, publish it to PyPI with `make publish`. It can then be installed via: ```bash -localstack extensions install "git+https://github.com/{{cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/#egg={{ cookiecutter.project_slug }}" +localstack extensions install {{ cookiecutter.project_slug }} ``` diff --git a/templates/basic/{{cookiecutter.project_slug}}/README.md b/templates/basic/{{cookiecutter.project_slug}}/README.md index 7240972b..7e20de1c 100644 --- a/templates/basic/{{cookiecutter.project_slug}}/README.md +++ b/templates/basic/{{cookiecutter.project_slug}}/README.md @@ -25,10 +25,10 @@ You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled ex EXTENSION_DEV_MODE=1 localstack start ``` -## Install from GitHub repository +## Publish to PyPI -To distribute your extension, simply upload it to your github account. Your extension can then be installed via: +To distribute your extension, publish it to PyPI with `make publish`. It can then be installed via: ```bash -localstack extensions install "git+https://github.com/{{cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/#egg={{ cookiecutter.project_slug }}" +localstack extensions install {{ cookiecutter.project_slug }} ``` diff --git a/templates/react/{{cookiecutter.project_slug}}/README.md b/templates/react/{{cookiecutter.project_slug}}/README.md index 8e083cd3..8518ece5 100644 --- a/templates/react/{{cookiecutter.project_slug}}/README.md +++ b/templates/react/{{cookiecutter.project_slug}}/README.md @@ -33,10 +33,10 @@ There are a few make commands available that will help your journey with the UI: - **start-frontend**: will start a live server on port 3000 (by default) that will allow you to have hot reloading when developing locally outside the extension (it will also build the frontend) -## Install from GitHub repository +## Publish to PyPI -To distribute your extension, simply upload it to your github account. Your extension can then be installed via: +To distribute your extension, publish it to PyPI with `make publish`. It can then be installed via: ```bash -localstack extensions install "git+https://github.com/{{cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/#egg={{ cookiecutter.project_slug }}" +localstack extensions install {{ cookiecutter.project_slug }} ``` diff --git a/terraform-init/README.md b/terraform-init/README.md index 5ac7075a..3c4ec19d 100644 --- a/terraform-init/README.md +++ b/terraform-init/README.md @@ -102,10 +102,8 @@ You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled ex EXTENSION_DEV_MODE=1 localstack start ``` -## Install from GitHub repository - -To distribute your extension, simply upload it to your github account. Your extension can then be installed via: +## Install from PyPI ```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-terraform-init&subdirectory=terraform-init" +localstack extensions install localstack-extension-terraform-init ``` diff --git a/typedb/README.md b/typedb/README.md index 8eeb3728..5b29ab15 100644 --- a/typedb/README.md +++ b/typedb/README.md @@ -21,12 +21,10 @@ The following environment variables can be passed to the LocalStack container (m * `localstack` CLI * `make` -## Install from GitHub repository - -This extension can be installed directly from this Github repo via: +## Install from PyPI ```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=typedb&subdirectory=typedb" +localstack extensions install localstack-extension-typedb ``` ## Install local development version diff --git a/utils/README.md b/utils/README.md index f55ed597..60cf1b9f 100644 --- a/utils/README.md +++ b/utils/README.md @@ -14,15 +14,6 @@ dependencies = [ ] ``` -Or, to install directly from the GitHub repository: - -```toml -[project] -dependencies = [ - "localstack-extensions-utils @ git+https://github.com/localstack/localstack-extensions.git#subdirectory=utils", -] -``` - Then import the utilities in your extension code, for example: ```python diff --git a/wiremock/README.md b/wiremock/README.md index 4d082c40..8fd8d4e7 100644 --- a/wiremock/README.md +++ b/wiremock/README.md @@ -15,12 +15,10 @@ The extension supports two modes: - `make` - [WireMock CLI](https://docs.wiremock.io/cli/overview) (for WireMock Runner mode) -## Install from GitHub repository - -This extension can be installed directly from this Github repo via: +## Install from PyPI ```bash -localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-wiremock&subdirectory=wiremock" +localstack extensions install localstack-wiremock ``` ## Install local development version