Update readme for local development

This commit is contained in:
Vineeth Voruganti 2024-02-01 10:34:39 -08:00
parent 6330b735d5
commit d4bfa12ffc
1 changed files with 5 additions and 12 deletions

View File

@ -111,23 +111,16 @@ poetry add honcho-ai
checkout the [example folder](./example/) for examples of how to use the sdk
#### Build Locally
#### Use Locally
For local development of the sdk you can build the sdk using poetry with the
following commands.
For local development of the sdk you can add the local directory as a package
using poetry with the following commands.
```bash
cd honcho/sdk
poetry build
poetry add --editable ./{path_to_honcho}/honcho/sdk
```
This will generate a `dist/` folder within the `honcho/sdk` directory. The
`dist/` will contain a wheel file. You can install the sdk in another local
project by specifiying the path to the wheel file in your installation command.
```bash
pip install ./dist/honcho-ai-0.0.1-py3-none-any.whl
```
See more information [here](https://python-poetry.org/docs/cli/#add)
## Contributing