Update contributing guide for publishing (#8)

* Update contributing guide for publishing Signed-off-by: Prithvi Kannan <[email protected]> * update readme with pypi Signed-off-by: Prithvi Kannan <[email protected]> --------- Signed-off-by: Prithvi Kannan <[email protected]>
databricks · Oct 28, 2024 · a002130 · a002130
1 parent e11c412
commit a002130
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 9 deletions.
diff --git 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/*
+```
diff --git 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://[email protected]/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
@@ -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://[email protected]/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://[email protected]/databricks/databricks-ai-bridge.git#subdirectory=integrations/langchain
+```
 
 ## Get started