Skip to content

Commit

Permalink
update readme to add proto steps (#3059)
Browse files Browse the repository at this point in the history
* update readme to add proto steps

* linting
  • Loading branch information
rachelyangdog authored Sep 18, 2024
1 parent ecb4cae commit 39044ff
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/scenarios/parametric.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,37 @@ docker image rm <library>-test-library
The Python implementation of the interface `app/python`, when run, provides a specification of the API when run.
See the steps below in the HTTP section to run the Python server and view the specification.

## Updating protos

In order to update the `parametric/protos`, these steps must be followed.

1. Create a virtual environment and activate it:
```bash
python3.12 -m venv .venv && source .venv/bin/activate
```

2. Install the required dependencies:
```bash
pip install -r requirements.txt
```

3. Install `grpcio-tools` (make sure grpcaio is the same version):
```bash
pip install grpcio-tools==1.60.1
```

4. Change directory to `utils/parametric`:
```console
cd utils/parametric
```

5. Run the script to generate the proto files:
```bash
./generate_protos.sh
```

Then you should have updated proto files. This script will generate weird files, you can ignore/delete these.

## Implementation

### Shared Interface
Expand Down

0 comments on commit 39044ff

Please sign in to comment.