Skip to content

Commit

Permalink
enhances README
Browse files Browse the repository at this point in the history
  • Loading branch information
fabricebrito committed Sep 2, 2024
1 parent 9940976 commit 8f2e312
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,35 @@ When encountering a Kubernetes API exception, Calrissian uses a library to retry

## For developers

* **Run tests**
### Installing for Development

Note that for development you can just use [Hatch] directly as described below.

### Installing Hatch

The main tool that is used for development is [Hatch]. It manages dependencies (in a virtualenv that is created on the fly) and is also the command runner.

So first, [install it][install Hatch]. Ideally in an isolated way with **`pipx install hatch`** (after [installing `pipx`]), or just `pip install hatch` as a more well-known way.

### Running tests

```
hatch run test:test
```

* **Run test coverage**
Verbose:

```
hatch run test:testv
```

### Running test coverage

```
hatch run test:cov
```

* **Run calrissian**
### Running calrissian

```
hatch run calrissian
Expand Down

0 comments on commit 8f2e312

Please sign in to comment.