You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2026/04/16 05:36:12 UTC

(streampipes) branch dev updated: fix: correct python client development setup (#4388)

This is an automated email from the ASF dual-hosted git repository.

bossenti pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes.git


The following commit(s) were added to refs/heads/dev by this push:
     new 9a77088e77 fix: correct python client development setup (#4388)
9a77088e77 is described below

commit 9a77088e773283fa3fa67a1b57b7312e3ea24842
Author: airwish <it...@outlook.com>
AuthorDate: Thu Apr 16 13:36:07 2026 +0800

    fix: correct python client development setup (#4388)
---
 streampipes-client-python/DEVELOPMENT.md                     | 11 ++++++-----
 streampipes-client-python/docs/getting-started/developing.md |  7 ++-----
 2 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/streampipes-client-python/DEVELOPMENT.md b/streampipes-client-python/DEVELOPMENT.md
index f803dcd645..e0c8bc4018 100644
--- a/streampipes-client-python/DEVELOPMENT.md
+++ b/streampipes-client-python/DEVELOPMENT.md
@@ -26,18 +26,19 @@ StreamPipes Python client :snake:.
 1) **Set up your Python environment**
 
 Create a virtual Python environment with a tool of your choice.
+To manage dependencies, we use [Poetry](https://python-poetry.org/), so please ensure `poetry` is installed. If it is not, you can refer to the [official Poetry installation documentation](https://python-poetry.org/docs/#installation).
 As a next step, install all required dependencies for development with `poetry`:
 
-```
-python -m pip install poetry
+```bash
 poetry install --with dev
 ```
 
 To include the all dependencies run:
 
-```
+```bash
 poetry install --with dev,docs,stubs,deployment
 ```
+
 <br>
 
 2) **Install pre-commit hook**
@@ -46,7 +47,7 @@ The pre-commit hook is run before every commit and takes care about code style,
 linting, type hints, import sorting, etc. It will stop your commit in case the changes do not apply the expected format.
 Always check to have the recent version of the pre-commit installed otherwise the CI build might fail:
 
-```
+```bash
 poetry run pre-commit install
 ```
 The definition of the pre-commit hook can be found in [.pre-commit-config.yaml](.pre-commit-config.yaml).
@@ -65,7 +66,7 @@ Please stick to the `numpy` style when writing docstrings, as we require this fo
 2) **Provide tests** :white_check_mark: <br>
 We are aiming for broad test coverage for the Python client and
 have therefore set a requirement of at least 90% unit test coverage.
-Therefore, please remember to write (unit) tests already during development. 
+Therefore, please remember to write (unit) tests already during development.
 If you have problems with writing tests, don't hesitate to ask us for help directly in the PR or
 even before that via our mailing list (see above).
 
diff --git a/streampipes-client-python/docs/getting-started/developing.md b/streampipes-client-python/docs/getting-started/developing.md
index 59e96cf568..411b96cdcf 100644
--- a/streampipes-client-python/docs/getting-started/developing.md
+++ b/streampipes-client-python/docs/getting-started/developing.md
@@ -25,10 +25,7 @@ This document describes how to easily set up your local dev environment to work
 1) **Set up your Python environment**
 
 Create a virtual Python environment using a tool of your choice.
-To manage dependencies, we use [Poetry](https://python-poetry.org/), so please install poetry in your local environment, e.g. via
-```bash
-pip install poetry
-```
+To manage dependencies, we use [Poetry](https://python-poetry.org/), so please ensure `poetry` is installed. If it is not, you can refer to the [official Poetry installation documentation](https://python-poetry.org/docs/#installation).
 
 Once poetry is installed you can simply finalize your Python environment by running:
 
@@ -48,7 +45,7 @@ Always check to have the recent version of the pre-commit hook installed otherwi
 If you are interested, you can have a deeper look on the underlying library: [pre-commit](https://pre-commit.com/).
 
 ```bash
-pre-commit install
+poetry run pre-commit install
 ```
 The definition of the pre-commit hook can be found in [.pre-commit-config.yaml](https://github.com/apache/streampipes/blob/dev/streampipes-client-python/.pre-commit-config.yaml).