From 3944f8c097111887db95d1546a8a3ac3077a9780 Mon Sep 17 00:00:00 2001 From: Prithvi Kannan Date: Fri, 25 Oct 2024 14:24:41 -0700 Subject: [PATCH 1/2] Update contributing guide for publishing Signed-off-by: Prithvi Kannan --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3baf1f5..e66cbd6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,34 @@ -Setting up dev environment +# Contributor's Guide + +## Setting up dev environment Create a conda environement and install dev requirements -``` +```sh conda create --name databricks-ai-dev-env python=3.10 conda activate databricks-ai-dev-env pip install -e ".[dev]" pip install -r requirements/lint-requirements.txt ``` + +## Publishing to PyPI + +Note: this section is for maitainers only. + +We recommend first uploading to test-PyPI + +### Publishing core package + + +```sh +python3 -m build --wheel +twine upload dist/* +``` + +### Publishing integration packages + +```sh +cd integrations/langchain +python3 -m build --wheel +twine upload dist/* +``` From dfb8c224b6af0eb740309b57214e8e861fee20ee Mon Sep 17 00:00:00 2001 From: Prithvi Kannan Date: Mon, 28 Oct 2024 10:48:18 -0700 Subject: [PATCH 2/2] update readme with pypi Signed-off-by: Prithvi Kannan --- README.md | 10 +++++++--- integrations/langchain/README.md | 11 +++++++---- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7724f9d..b60c7d0 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,15 @@ The Databricks AI Bridge library provides a shared layer of APIs to interact wit ## Installation +### Install from PyPI +```sh +pip install databricks-ai-bridge +``` + +### Install from source + ```sh -# install from the source pip install git+ssh://git@github.com/databricks/databricks-ai-bridge.git ``` -> [!NOTE] -> Once this package is published to PyPI, users can install via `pip install databricks-ai-bridge` diff --git a/integrations/langchain/README.md b/integrations/langchain/README.md index e09794a..ff07811 100644 --- a/integrations/langchain/README.md +++ b/integrations/langchain/README.md @@ -4,13 +4,16 @@ Integrate Databricks AI Bridge package with Langchain to allow seamless usage of ## Installation +### Install from PyPI ```sh -# install from the source -pip install git+ssh://git@github.com/databricks/databricks-ai-bridge.git#subdirectory=integrations/langchain +pip install databricks-langchain ``` -> [!NOTE] -> Once this package is published to PyPI, users can install via `pip install databricks-langchain` +### Install from source + +```sh +pip install git+ssh://git@github.com/databricks/databricks-ai-bridge.git#subdirectory=integrations/langchain +``` ## Get started