docs: clarify python client installation steps (#796)

* docs: clarify python client installation steps Signed-off-by: Eric Dobroveanu <[email protected]> * docs: adjust testing section in python client readme Signed-off-by: Eric Dobroveanu <[email protected]> --------- Signed-off-by: Eric Dobroveanu <[email protected]>
kubeflow · Feb 13, 2025 · 2e7fd2d · 2e7fd2d
1 parent 2b1b4d6
commit 2e7fd2d
Showing 1 changed file with 20 additions and 5 deletions.
diff --git a/clients/python/README.md b/clients/python/README.md
@@ -185,16 +185,31 @@ Currently, the Model Registry backend treats model lists as a circular buffer, a
 
 ## Development
 
+### Using the Makefile
+
+The `Makefile` contains most common development tasks
+
+To install dependencies:
+
+```bash
+make
+```
+
+Then you can run tests:
+
+```bash
+make test test-e2e
+```
+
+### Using Nox
+
 Common tasks, such as building documentation and running tests, can be executed using [`nox`](https://github.com/wntrblm/nox) sessions.
 
 Use `nox -l` to list sessions and execute them using `nox -s [session]`.
 
-Alternatively, use `make install` to setup a local Python virtual environment with `poetry`.
+### Testing requirements
 
-To run the tests you will need `docker` (or equivalent) and the `compose` extension command.
-This is necessary as the test suite will manage a Model Registry server and an MLMD instance to ensure a clean state on
-each run.
-You can use `make test` to execute `pytest`.
+To run the e2e tests you will need [kind](https://kind.sigs.k8s.io/) to be installed. This is necessary as the e2e test suite will manage a Model Registry deployment and an MLMD deployment to ensure a clean MR target on each run.
 
 ### Running Locally on Mac M1 or M2 (arm64 architecture)