Skip to content

Commit 5aea6ec

Browse files
Merge pull request #1196 from element-hq/gaelg/fix-readme
Fix tool readme
2 parents 277cbd1 + 1a052ec commit 5aea6ec

2 files changed

Lines changed: 26 additions & 2 deletions

File tree

newsfragments/1196.internal.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CI: Publish ESS tests as a python package for use in external projects and developers environments.

tests/README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,37 @@ The ESS Community Integration Tests project is designed to facilitate the testin
1919
- Docker
2020
- [k3d](https://k3d.io/stable/)
2121
- [Helm](https://helm.sh/docs/intro/install)
22+
- Optional: [uv](https://docs.astral.sh/uv/getting-started/installation/) to install from git
2223

2324
## Installation
2425

25-
Either using `uv` or `pipx`:
2626

2727
```sh
2828
pipx install ess-community-integration-tests
29-
uv tool install ess-community-integration-tests
29+
uvx ess-community-integration-tests
30+
```
31+
32+
You can also install it from the git repository :
33+
34+
```sh
35+
# You can also use any ESS Community version
36+
VERSION=main
37+
uvx git+https://github.com/element-hq/ess-helm.git@$VERSION$#subdirectory=tests
38+
```
39+
40+
Example:
41+
42+
```sh
43+
VERSION=main
44+
uvx git+https://github.com/element-hq/ess-helm.git@$VERSION#subdirectory=tests
45+
Updated https://github.com/element-hq/ess-helm.git (d6d33a7f7051a0b6bbdcc609a059ae328feee269)
46+
Built ess-community-integration-tests @ git+https://github.com/element-hq/ess-helm.git@d6d33a7f7051a0b6bbdcc609a059ae328feee269#subdirectory=tests
47+
Installed 60 packages in 5ms
48+
An executable named `ess-community-integration-tests` is not provided by package `ess-community-integration-tests`.
49+
The following executables are available:
50+
- collect-ess-logs
51+
- pytest-ess
52+
- setup-ess-cluster
3053
```
3154

3255
## Usage

0 commit comments

Comments
 (0)