Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasvanmol committed Dec 19, 2024
1 parent dfa2f94 commit 37d6f78
Showing 1 changed file with 44 additions and 7 deletions.
51 changes: 44 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,62 @@

## Development

### Testing
Cascade should work with Python 3.10 / 3.11 although other versions could work. Dependencies should first be installed with:

For unit tests:
```
pip install -r requirements.txt
```

## Testing

The `pip install` command should have installed a suitable version of `pytest`.

```
pytest --version
```

Depending on your python install you may have to run `python -m pytest` instead.

### Unit Tests

For unit tests, you can run the following command:

```
pytest
```

Integration tests require Kafka to be running (with `docker compose up`):

### Integration Tests

Integration tests require the Kafka service to be running.
You can launch it with:

```
docker compose up -d
```

This will launch:
- a Kafka broker at localhost:9092 and,
- a [Kafbat UI](https://github.com/kafbat/kafka-ui) at http://localhost:8080

Before running integration tests, it's best to purge all existing messages.
This can be done in the Kafbat UI (under the `Topics` tab) or by fully
restarting the container:

```
pytest -m integration
docker compose down
docker compose up -d
```

You should then be able to run integration tests with the following command:

```
pytest -m integration
```

### Documentation
## Documentation

Documentation is done with [Google style docstrings](https://google.github.io/styleguide/pyguide.html) in the source code.
It can be generated using [pdoc](https://pdoc.dev/docs/pdoc.html):
Documentation can be generated using [pdoc](https://pdoc.dev/docs/pdoc.html):

```
pdoc --mermaid src/cascade
Expand Down

0 comments on commit 37d6f78

Please sign in to comment.