From d4bfa12ffc3572df2073cdd7143fcdade9da7e3d Mon Sep 17 00:00:00 2001 From: Vineeth Voruganti <13438633+VVoruganti@users.noreply.github.com> Date: Thu, 1 Feb 2024 10:34:39 -0800 Subject: [PATCH] Update readme for local development --- README.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 08b1f679..49a8c1dc 100644 --- a/README.md +++ b/README.md @@ -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