Merge pull request #1196 from element-hq/gaelg/fix-readme

Fix tool readme
This commit is contained in:
Gaël Goinvic authored and GitHub committed 2026-03-27 14:44:03 +01:00
commit 5aea6ec001
2 files changed
+26 -2

No files matched your search

+1
View File
@@ -0,0 +1 @@
CI: Publish ESS tests as a python package for use in external projects and developers environments.
+25 -2
View File
@@ -19,14 +19,37 @@ The ESS Community Integration Tests project is designed to facilitate the testin
- Docker
- [k3d](https://k3d.io/stable/)
- [Helm](https://helm.sh/docs/intro/install)
- Optional: [uv](https://docs.astral.sh/uv/getting-started/installation/) to install from git
## Installation
Either using `uv` or `pipx`:
```sh
pipx install ess-community-integration-tests
uv tool install ess-community-integration-tests
uvx ess-community-integration-tests
```
You can also install it from the git repository :
```sh
# You can also use any ESS Community version
VERSION=main
uvx git+https://github.com/element-hq/ess-helm.git@$VERSION$#subdirectory=tests
```
Example:
```sh
VERSION=main
uvx git+https://github.com/element-hq/ess-helm.git@$VERSION#subdirectory=tests
Updated https://github.com/element-hq/ess-helm.git (d6d33a7f7051a0b6bbdcc609a059ae328feee269)
Built ess-community-integration-tests @ git+https://github.com/element-hq/ess-helm.git@d6d33a7f7051a0b6bbdcc609a059ae328feee269#subdirectory=tests
Installed 60 packages in 5ms
An executable named `ess-community-integration-tests` is not provided by package `ess-community-integration-tests`.
The following executables are available:
- collect-ess-logs
- pytest-ess
- setup-ess-cluster
```
## Usage