Skip to content

Commit

Permalink
add samples link to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
longquanzheng committed Sep 13, 2023
1 parent f3f48a9 commit 0fd2db3
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,18 @@

Python SDK for [iWF workflow engine](https://github.com/indeedeng/iwf)

TODO: samples
```
pip install iwf-python-sdk==0.1.0
```

See [documentation](https://github.com/indeedeng/iwf#what-is-iwf).

See [samples](https://github.com/indeedeng/iwf-python-samples) for examples.

## Requirements

- Python 3.9+
- [iWF server](https://github.com/indeedeng/iwf#using-docker-image--docker-compose)

## How to use

Expand Down Expand Up @@ -113,11 +120,10 @@ git submodule update --remote --merge
This project uses [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) to generate an API client from the IDL. To update the generated client:
```bash
poetry run openapi-python-client update --path iwf-idl/iwf-sdk.yaml --config .openapi-python-client-config.yaml
cd iwf && poetry run openapi-python-client update --path ../iwf-idl/iwf-sdk.yaml --config .openapi-python-client-config.yam
```
Then update the version in `iwf-api/pyproject.toml` so that poetry can know that the local path dependency package is updated.
Then run `poetry update` to update the local path dependency.
Then run `cd .. && poetry update` to update the local path dependency.
#### Linting
To run linting for this project:
Expand Down

0 comments on commit 0fd2db3

Please sign in to comment.