From 3944f8c097111887db95d1546a8a3ac3077a9780 Mon Sep 17 00:00:00 2001 From: Prithvi Kannan Date: Fri, 25 Oct 2024 14:24:41 -0700 Subject: [PATCH] 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/* +```