Skip to content
This repository has been archived by the owner on Sep 2, 2024. It is now read-only.

Commit

Permalink
Update README for GUI
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasmittag committed Jul 20, 2023
1 parent 97f9f29 commit 7f6f478
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion mock_service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The full Python mocking DSL can be found [here](./doc/pydoc/mocking-dsl.md)

# Running mockservice

Firstly, you will need to install all necessary Python dependencies by issuing the following command in your favorite terminal:
Firstly, you will need to install all necessary Python dependencies by using the following command in your favorite terminal:

```bash
python3 -m pip install -r ./requirements.txt
Expand All @@ -67,6 +67,31 @@ cd mock
python3 mockservice.py
```

# Running showcase GUI

Firstly, you will need to install all necessary Python dependencies by using the following command in your favorite terminal:

```bash
# install requirements of mock service
python3 -m pip install -r ./requirements.txt
# install additional requirements of the GUI
python3 -m pip install --pre kuksa-client
# install mock service from mock_service directory to make it available in the GUI
python3 -m pip install -e .
```

To run the GUI do the following in your favourtie terminal:

```bash
python3 showcase_gui/GUI.py
```

If you run it from mock directory the mock datapoints defined by mock.py get used as well:
```bash
cd mock
python3 ../showcase_gui/GUI.py
```

# Generating API documentation

API documentation is generated from Python docs and embedded into markdown files for easy rendering on Github without external hosting. The workflow `ensure-docs-up2date` makes sure that the API docs are up to date before merging a pull request. To update the docs, run
Expand Down

0 comments on commit 7f6f478

Please sign in to comment.