generated from langchain-ai/integration-repo-template
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* init pkg * x * x * x * x * x
- Loading branch information
Showing
26 changed files
with
5,544 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1,5 @@ | ||
# 🦜️🔗 LangChain {partner} | ||
# 🦜️🔗 LangChain Databricks | ||
|
||
This repository contains {n} packages with {partner} integrations with LangChain: | ||
This repository contains 1 package with Databricks integrations with LangChain: | ||
|
||
- [langchain-{package}](https://pypi.org/project/langchain-{package}/) integrates [{product}}]({product_link}). | ||
{- ... if more packages} | ||
|
||
## Initial Repo Checklist (Remove this section after completing) | ||
|
||
This setup assumes that the partner package is already split. For those instructions, | ||
see [these docs](https://python.langchain.com/docs/contributing/integrations#partner-packages). | ||
|
||
Code | ||
|
||
- [ ] Fill out the readme above (for folks that follow pypi link) | ||
- [ ] Copy package into /libs folder | ||
- [ ] Update these fields in /libs/*/pyproject.toml | ||
|
||
- `tool.poetry.repository` | ||
- `tool.poetry.urls["Source Code"]` | ||
|
||
Workflow code | ||
|
||
- [ ] Add secrets as env vars in .github/workflows/_release.yml | ||
- [ ] Populate .github/workflows/_release.yml with `on.workflow_dispatch.inputs.working-directory.default` | ||
- [ ] Configure `LIB_DIRS` in .github/scripts/check_diff.py | ||
|
||
In github | ||
|
||
- [ ] Add integration testing secrets in Github (ask Erick for help) | ||
- [ ] Add partner collaborators in Github (ask Erick for help) | ||
- [ ] "Allow auto-merge" in General Settings | ||
- [ ] Only "Allow squash merging" in General Settings | ||
- [ ] Set up ruleset matching CI build (ask Erick for help) | ||
- name: ci build | ||
- enforcement: active | ||
- bypass: write | ||
- target: default branch | ||
- rules: restrict deletions, require status checks ("CI Success"), block force pushes | ||
|
||
Pypi | ||
|
||
- [ ] Add new repo to test-pypi and pypi trusted publishing (ask Erick for help) | ||
|
||
Slack | ||
|
||
- [ ] Set up release alerting in Slack (ask Erick for help) | ||
|
||
release: | ||
/github subscribe langchain-ai/langchain-{partner} releases workflows:{name:"release"} | ||
/github unsubscribe langchain-ai/langchain-{partner} issues pulls commits deployments | ||
- [langchain-databricks](https://pypi.org/project/langchain-databricks/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__pycache__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 LangChain, Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
.PHONY: all format lint test tests integration_tests docker_tests help extended_tests | ||
|
||
# Default target executed when no arguments are given to make. | ||
all: help | ||
|
||
# Define a variable for the test file path. | ||
TEST_FILE ?= tests/unit_tests/ | ||
integration_test integration_tests: TEST_FILE = tests/integration_tests/ | ||
|
||
|
||
# unit tests are run with the --disable-socket flag to prevent network calls | ||
test tests: | ||
poetry run pytest --disable-socket --allow-unix-socket $(TEST_FILE) | ||
|
||
# integration tests are run without the --disable-socket flag to allow network calls | ||
integration_test integration_tests: | ||
poetry run pytest $(TEST_FILE) | ||
|
||
###################### | ||
# LINTING AND FORMATTING | ||
###################### | ||
|
||
# Define a variable for Python and notebook files. | ||
PYTHON_FILES=. | ||
MYPY_CACHE=.mypy_cache | ||
lint format: PYTHON_FILES=. | ||
lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/databricks --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$') | ||
lint_package: PYTHON_FILES=langchain_databricks | ||
lint_tests: PYTHON_FILES=tests | ||
lint_tests: MYPY_CACHE=.mypy_cache_test | ||
|
||
lint lint_diff lint_package lint_tests: | ||
poetry run ruff check . | ||
poetry run ruff format $(PYTHON_FILES) --diff | ||
poetry run ruff check --select I $(PYTHON_FILES) | ||
mkdir -p $(MYPY_CACHE); poetry run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE) | ||
|
||
format format_diff: | ||
poetry run ruff format $(PYTHON_FILES) | ||
poetry run ruff check --select I --fix $(PYTHON_FILES) | ||
|
||
spell_check: | ||
poetry run codespell --toml pyproject.toml | ||
|
||
spell_fix: | ||
poetry run codespell --toml pyproject.toml -w | ||
|
||
check_imports: $(shell find langchain_databricks -name '*.py') | ||
poetry run python ./scripts/check_imports.py $^ | ||
|
||
###################### | ||
# HELP | ||
###################### | ||
|
||
help: | ||
@echo '----' | ||
@echo 'check_imports - check imports' | ||
@echo 'format - run code formatters' | ||
@echo 'lint - run linters' | ||
@echo 'test - run unit tests' | ||
@echo 'tests - run unit tests' | ||
@echo 'test TEST_FILE=<test_file> - run all tests in file' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# langchain-databricks | ||
|
||
This package contains the LangChain integration with Databricks | ||
|
||
## Installation | ||
|
||
```bash | ||
pip install -U langchain-databricks | ||
``` | ||
|
||
And you should configure credentials by setting the following environment variables: | ||
|
||
* TODO: fill this out | ||
|
||
## Chat Models | ||
|
||
`ChatDatabricks` class exposes chat models from Databricks. | ||
|
||
```python | ||
from langchain_databricks import ChatDatabricks | ||
|
||
llm = ChatDatabricks() | ||
llm.invoke("Sing a ballad of LangChain.") | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
from importlib import metadata | ||
|
||
from langchain_databricks.chat_models import ChatDatabricks | ||
from langchain_databricks.embeddings import DatabricksEmbeddings | ||
from langchain_databricks.vectorstores import DatabricksVectorSearch | ||
|
||
try: | ||
__version__ = metadata.version(__package__) | ||
except metadata.PackageNotFoundError: | ||
# Case where package metadata is not available. | ||
__version__ = "" | ||
del metadata # optional, avoids polluting the results of dir(__package__) | ||
|
||
__all__ = [ | ||
"ChatDatabricks", | ||
"DatabricksEmbeddings", | ||
"DatabricksVectorSearch", | ||
"__version__", | ||
] |
Oops, something went wrong.