Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing guide for publishing #8

Merged
merged 3 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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/*
```
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

11 changes: 7 additions & 4 deletions integrations/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading