Update readme for local development
This commit is contained in:
parent
6330b735d5
commit
d4bfa12ffc
17
README.md
17
README.md
|
|
@ -111,23 +111,16 @@ poetry add honcho-ai
|
||||||
|
|
||||||
checkout the [example folder](./example/) for examples of how to use the sdk
|
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
|
For local development of the sdk you can add the local directory as a package
|
||||||
following commands.
|
using poetry with the following commands.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd honcho/sdk
|
poetry add --editable ./{path_to_honcho}/honcho/sdk
|
||||||
poetry build
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This will generate a `dist/` folder within the `honcho/sdk` directory. The
|
See more information [here](https://python-poetry.org/docs/cli/#add)
|
||||||
`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
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue