update naming (#26)

* update naming * fix lint/fmt
datastax · Jan 17, 2025 · 8808ac0 · 8808ac0
1 parent d387bbe
commit 8808ac0
Show file tree

Hide file tree

Showing 53 changed files with 67 additions and 62 deletions.
diff --git a/.github/actions/setup-python-env/action.yml b/.github/actions/setup-python-env/action.yml
@@ -17,5 +17,5 @@ runs:
         cache-suffix: ${{ matrix.python-version }}
 
     - name: Install Python dependencies
-      run: uv sync --frozen --package langchain-graph-rag
+      run: uv sync --frozen --package langchain-graph-retriever
       shell: bash
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -68,9 +68,9 @@ jobs:
 
       - name: Run `make test`
         run:
-            uv run --package langchain-graph-rag python -m pytest -vs
-                ./packages/langchain-graph-rag/tests/unit_tests/
-                ./packages/langchain-graph-rag/tests/integration_tests/
+            uv run --package langchain-graph-retriever python -m pytest -vs
+                ./packages/langchain-graph-retriever/tests/unit_tests/
+                ./packages/langchain-graph-retriever/tests/integration_tests/
                 --stores=mem_norm --stores=mem --stores=cassandra --stores=chroma --stores=opensearch
                 --junitxml=junit/test-results-${{ matrix.python-version }}.xml
 

diff --git a/Makefile b/Makefile
@@ -31,12 +31,12 @@ lock:
 
 .PHONY: deptry-gr deptry-lgr deptry
 deptry-gr:
-	@echo "🚀 Checking for obsolete dependencies: Running deptry on graph-rag"
-	cd packages/graph-rag && uvx $(DEPTRY) src tests
+	@echo "🚀 Checking for obsolete dependencies: Running deptry on graph-retriever"
+	cd packages/graph-retriever && uvx $(DEPTRY) src tests
 
 deptry-lgr:
-	@echo "🚀 Checking for obsolete dependencies: Running deptry on langchain-graph-rag"
-	cd packages/langchain-graph-rag && uvx $(DEPTRY) src tests
+	@echo "🚀 Checking for obsolete dependencies: Running deptry on langchain-graph-retriever"
+	cd packages/langchain-graph-retriever && uvx $(DEPTRY) src tests
 
 deptry: deptry-gr deptry-lgr
 
@@ -49,42 +49,42 @@ docker-up:
 docker-down:
 	docker compose down --rmi local
 
-.PHONY: sync-langchain-graph-rag
-sync-langchain-graph-rag:
-	@uv sync --package langchain-graph-rag
+.PHONY: sync-langchain-graph-retriever
+sync-langchain-graph-retriever:
+	@uv sync --package langchain-graph-retriever
 
-.PHONY: sync-graph-rag
-sync-graph-rag:
-	@uv sync --package graph-rag
+.PHONY: sync-graph-retriever
+sync-graph-retriever:
+	@uv sync --package graph-retriever
 
 .PHONY: integration
 integration:
-	@echo "🚀 Testing code: Running pytest ./packages/langchain-graph-rag/tests/integration_tests (in memory only)"
-	@uv run --project langchain-graph-rag pytest -vs ./packages/langchain-graph-rag/tests/integration_tests/
+	@echo "🚀 Testing code: Running pytest ./packages/langchain-graph-retriever/tests/integration_tests (in memory only)"
+	@uv run --package langchain-graph-retriever pytest -vs ./packages/langchain-graph-retriever/tests/integration_tests/
 
 .PHONY: unit
 unit:
-	@echo "🚀 Testing code: Running pytest ./packages/langchain-graph-rag/tests/unit_tests/"
-	@uv run --project langchain-graph-rag pytest -vs ./packages/langchain-graph-rag/tests/unit_tests/
+	@echo "🚀 Testing code: Running pytest ./packages/langchain-graph-retriever/tests/unit_tests/"
+	@uv run --package langchain-graph-retriever pytest -vs ./packages/langchain-graph-retriever/tests/unit_tests/
 
 .PHONY: test
-test: sync-langchain-graph-rag
+test: sync-langchain-graph-retriever
 	@echo "🚀 Testing code: Running pytest"
-	@uv run --project langchain-graph-rag python -m pytest -vs ./packages/langchain-graph-rag/tests/ --stores=all
+	@cd packages/langchain-graph-retriever && uv run pytest -vs ./tests/unit_tests ./tests/integration_tests --stores=all
 
 .PHONY: mypy
 mypy:
 	@echo "🚀 Static type checking: Running mypy"
-	@uv run --project langchain-graph-rag mypy ./packages/langchain-graph-rag
+	@uv run --package langchain-graph-retriever mypy ./packages/langchain-graph-retriever
 
 lint: fmt fix mypy
 
-.PHONY: build-langchain-graph-rag
-build-langchain-graph-rag: sync-langchain-graph-rag
-	@echo "🚀 Building langchain-graph-rag package"
-	@uv build --package langchain-graph-rag
+.PHONY: build-langchain-graph-retriever
+build-langchain-graph-retriever: sync-langchain-graph-retriever
+	@echo "🚀 Building langchain-graph-retriever package"
+	@uv build --package langchain-graph-retriever
 
-.PHONY: build-graph-rag
-build-graph-rag: sync-graph-rag
-	@echo "🚀 Building graph-rag package"
-	@uv build --package graph-rag
+.PHONY: build-graph-retriever
+build-graph-retriever: sync-graph-retriever
+	@echo "🚀 Building graph-retriever package"
+	@uv build --package graph-retriever
diff --git a/packages/graph-rag/README.md b/packages/graph-rag/README.md
diff --git a/packages/graph-retriever/README.md b/packages/graph-retriever/README.md
@@ -0,0 +1 @@
+# graph-retriever
diff --git a/packages/graph-rag/pyproject.toml → packages/graph-retriever/pyproject.toml b/packages/graph-rag/pyproject.toml → packages/graph-retriever/pyproject.toml
@@ -1,5 +1,5 @@
 [project]
-name = "graph-rag"
+name = "graph-retriever"
 version = "0.0.0"
 description = "Add your description here"
 readme = "README.md"

diff --git a/packages/graph-rag/src/graph_rag/__init__.py → ...retriever/src/graph_retriever/__init__.py b/packages/graph-rag/src/graph_rag/__init__.py → ...retriever/src/graph_retriever/__init__.py
diff --git a/packages/graph-rag/tests/__init__.py → packages/graph-retriever/tests/__init__.py b/packages/graph-rag/tests/__init__.py → packages/graph-retriever/tests/__init__.py
diff --git a/packages/langchain-graph-rag/README.md b/packages/langchain-graph-rag/README.md
diff --git a/packages/langchain-graph-retriever/README.md b/packages/langchain-graph-retriever/README.md
@@ -0,0 +1 @@
+# langchain-graph-retriever
diff --git a/packages/langchain-graph-rag/pyproject.toml → .../langchain-graph-retriever/pyproject.toml b/packages/langchain-graph-rag/pyproject.toml → .../langchain-graph-retriever/pyproject.toml
@@ -1,5 +1,5 @@
 [project]
-name = "langchain-graph-rag"
+name = "langchain-graph-retriever"
 version = "0.0.1"
 description = "Add your description here"
 readme = "README.md"

diff --git a/...h-rag/src/langchain_graph_rag/__init__.py → ...src/langchain_graph_retriever/__init__.py b/...h-rag/src/langchain_graph_rag/__init__.py → ...src/langchain_graph_retriever/__init__.py
diff --git a/...t_transformers/gliner_entity_extractor.py → ...t_transformers/gliner_entity_extractor.py b/...t_transformers/gliner_entity_extractor.py → ...t_transformers/gliner_entity_extractor.py
diff --git a/..._transformers/hierarchy_link_extractor.py → ..._transformers/hierarchy_link_extractor.py b/..._transformers/hierarchy_link_extractor.py → ..._transformers/hierarchy_link_extractor.py
diff --git a/..._transformers/html_hyperlink_extractor.py → ..._transformers/html_hyperlink_extractor.py b/..._transformers/html_hyperlink_extractor.py → ..._transformers/html_hyperlink_extractor.py
diff --git a/...transformers/keybert_keyword_extractor.py → ...transformers/keybert_keyword_extractor.py b/...transformers/keybert_keyword_extractor.py → ...transformers/keybert_keyword_extractor.py
diff --git a/...ent_transformers/metadata_denormalizer.py → ...ent_transformers/metadata_denormalizer.py b/...ent_transformers/metadata_denormalizer.py → ...ent_transformers/metadata_denormalizer.py
diff --git a/...raph-rag/src/langchain_graph_rag/py.typed → ...er/src/langchain_graph_retriever/py.typed b/...raph-rag/src/langchain_graph_rag/py.typed → ...er/src/langchain_graph_retriever/py.typed
diff --git a/...rc/langchain_graph_rag/retrievers/edge.py → ...gchain_graph_retriever/retrievers/edge.py b/...rc/langchain_graph_rag/retrievers/edge.py → ...gchain_graph_retriever/retrievers/edge.py
diff --git a/...chain_graph_rag/retrievers/edge_helper.py → ...graph_retriever/retrievers/edge_helper.py b/...chain_graph_rag/retrievers/edge_helper.py → ...graph_retriever/retrievers/edge_helper.py
diff --git a/...g/retrievers/graph_traversal_retriever.py → ...r/retrievers/graph_traversal_retriever.py b/...g/retrievers/graph_traversal_retriever.py → ...r/retrievers/graph_traversal_retriever.py
diff --git a/...rc/langchain_graph_rag/retrievers/node.py → ...gchain_graph_retriever/retrievers/node.py b/...rc/langchain_graph_rag/retrievers/node.py → ...gchain_graph_retriever/retrievers/node.py
diff --git a/...rag/retrievers/store_adapters/__init__.py → ...ver/retrievers/store_adapters/__init__.py b/...rag/retrievers/store_adapters/__init__.py → ...ver/retrievers/store_adapters/__init__.py
diff --git a/...ph_rag/retrievers/store_adapters/astra.py → ...riever/retrievers/store_adapters/astra.py b/...ph_rag/retrievers/store_adapters/astra.py → ...riever/retrievers/store_adapters/astra.py
diff --git a/...aph_rag/retrievers/store_adapters/base.py → ...triever/retrievers/store_adapters/base.py b/...aph_rag/retrievers/store_adapters/base.py → ...triever/retrievers/store_adapters/base.py
diff --git a/...ag/retrievers/store_adapters/cassandra.py → ...er/retrievers/store_adapters/cassandra.py b/...ag/retrievers/store_adapters/cassandra.py → ...er/retrievers/store_adapters/cassandra.py
diff --git a/...h_rag/retrievers/store_adapters/chroma.py → ...iever/retrievers/store_adapters/chroma.py b/...h_rag/retrievers/store_adapters/chroma.py → ...iever/retrievers/store_adapters/chroma.py
diff --git a/...ag/retrievers/store_adapters/in_memory.py → ...er/retrievers/store_adapters/in_memory.py b/...ag/retrievers/store_adapters/in_memory.py → ...er/retrievers/store_adapters/in_memory.py
diff --git a/.../retrievers/store_adapters/open_search.py → .../retrievers/store_adapters/open_search.py b/.../retrievers/store_adapters/open_search.py → .../retrievers/store_adapters/open_search.py
diff --git a/...graph_rag/retrievers/strategy/__init__.py → ...retriever/retrievers/strategy/__init__.py b/...graph_rag/retrievers/strategy/__init__.py → ...retriever/retrievers/strategy/__init__.py
diff --git a/...ain_graph_rag/retrievers/strategy/base.py → ...aph_retriever/retrievers/strategy/base.py b/...ain_graph_rag/retrievers/strategy/base.py → ...aph_retriever/retrievers/strategy/base.py
diff --git a/...in_graph_rag/retrievers/strategy/eager.py → ...ph_retriever/retrievers/strategy/eager.py b/...in_graph_rag/retrievers/strategy/eager.py → ...ph_retriever/retrievers/strategy/eager.py
diff --git a/...hain_graph_rag/retrievers/strategy/mmr.py → ...raph_retriever/retrievers/strategy/mmr.py b/...hain_graph_rag/retrievers/strategy/mmr.py → ...raph_retriever/retrievers/strategy/mmr.py
@@ -3,7 +3,7 @@
 from typing import Iterable
 
 import numpy as np
-from langchain_graph_rag.utils.math import cosine_similarity
+from langchain_graph_retriever.utils.math import cosine_similarity
 from numpy.typing import NDArray
 from pydantic import Field
 

diff --git a/...n_graph_rag/retrievers/strategy/scored.py → ...h_retriever/retrievers/strategy/scored.py b/...n_graph_rag/retrievers/strategy/scored.py → ...h_retriever/retrievers/strategy/scored.py
diff --git a/...rag/src/langchain_graph_rag/utils/math.py → ...c/langchain_graph_retriever/utils/math.py b/...rag/src/langchain_graph_rag/utils/math.py → ...c/langchain_graph_retriever/utils/math.py
diff --git a/...ges/langchain-graph-rag/tests/__init__.py → ...ngchain-graph-retriever/tests/__init__.py b/...ges/langchain-graph-rag/tests/__init__.py → ...ngchain-graph-retriever/tests/__init__.py
diff --git a/...ges/langchain-graph-rag/tests/conftest.py → ...ngchain-graph-retriever/tests/conftest.py b/...ges/langchain-graph-rag/tests/conftest.py → ...ngchain-graph-retriever/tests/conftest.py
diff --git a/...in-graph-rag/tests/embeddings/__init__.py → ...ph-retriever/tests/embeddings/__init__.py b/...in-graph-rag/tests/embeddings/__init__.py → ...ph-retriever/tests/embeddings/__init__.py
diff --git a/...rag/tests/embeddings/simple_embeddings.py → ...ver/tests/embeddings/simple_embeddings.py b/...rag/tests/embeddings/simple_embeddings.py → ...ver/tests/embeddings/simple_embeddings.py
diff --git a/...rag/tests/integration_tests/assertions.py → ...ver/tests/integration_tests/assertions.py b/...rag/tests/integration_tests/assertions.py → ...ver/tests/integration_tests/assertions.py
diff --git a/...h-rag/tests/integration_tests/conftest.py → ...iever/tests/integration_tests/conftest.py b/...h-rag/tests/integration_tests/conftest.py → ...iever/tests/integration_tests/conftest.py
diff --git a/...ph-rag/tests/integration_tests/invoker.py → ...riever/tests/integration_tests/invoker.py b/...ph-rag/tests/integration_tests/invoker.py → ...riever/tests/integration_tests/invoker.py
diff --git a/...tegration_tests/retrievers/animal_docs.py → ...tegration_tests/retrievers/animal_docs.py b/...tegration_tests/retrievers/animal_docs.py → ...tegration_tests/retrievers/animal_docs.py
@@ -1,4 +1,5 @@
 import json
+import os
 
 import pytest
 from langchain_core.documents import Document
@@ -9,7 +10,11 @@
 @pytest.fixture(scope="session")
 def animal_docs() -> list[Document]:
     documents = []
-    with open("data/animals.jsonl", "r") as file:
+
+    path = os.path.abspath(
+        os.path.join(os.path.dirname(__file__), "../../../../../data/animals.jsonl")
+    )
+    with open(path, "r") as file:
         for line in file:
             data = json.loads(line.strip())
             documents.append(

diff --git a/.../integration_tests/retrievers/conftest.py → .../integration_tests/retrievers/conftest.py b/.../integration_tests/retrievers/conftest.py → .../integration_tests/retrievers/conftest.py
diff --git a/...ntegration_tests/retrievers/earth_docs.py → ...ntegration_tests/retrievers/earth_docs.py b/...ntegration_tests/retrievers/earth_docs.py → ...ntegration_tests/retrievers/earth_docs.py
@@ -1,6 +1,6 @@
 import pytest
 from langchain_core.documents import Document
-from langchain_graph_rag.retrievers.store_adapters import StoreAdapter
+from langchain_graph_retriever.retrievers.store_adapters import StoreAdapter
 from tests.embeddings.simple_embeddings import EarthEmbeddings
 from tests.integration_tests.stores import StoreFactory
 

diff --git a/...tegration_tests/retrievers/parser_docs.py → ...tegration_tests/retrievers/parser_docs.py b/...tegration_tests/retrievers/parser_docs.py → ...tegration_tests/retrievers/parser_docs.py
diff --git a/.../retrievers/test_graph_traversal_eager.py → .../retrievers/test_graph_traversal_eager.py b/.../retrievers/test_graph_traversal_eager.py → .../retrievers/test_graph_traversal_eager.py
@@ -1,8 +1,8 @@
 from langchain_core.documents import Document
-from langchain_graph_rag.retrievers.graph_traversal_retriever import (
+from langchain_graph_retriever.retrievers.graph_traversal_retriever import (
     GraphTraversalRetriever,
 )
-from langchain_graph_rag.retrievers.strategy.eager import (
+from langchain_graph_retriever.retrievers.strategy.eager import (
     Eager,
 )
 from tests.integration_tests.assertions import assert_document_format, sorted_doc_ids

diff --git a/...ts/retrievers/test_graph_traversal_mmr.py → ...ts/retrievers/test_graph_traversal_mmr.py b/...ts/retrievers/test_graph_traversal_mmr.py → ...ts/retrievers/test_graph_traversal_mmr.py
@@ -1,12 +1,12 @@
 from langchain_core.documents import Document
 from langchain_core.vectorstores import InMemoryVectorStore
-from langchain_graph_rag.retrievers.graph_traversal_retriever import (
+from langchain_graph_retriever.retrievers.graph_traversal_retriever import (
     GraphTraversalRetriever,
 )
-from langchain_graph_rag.retrievers.store_adapters.in_memory import (
+from langchain_graph_retriever.retrievers.store_adapters.in_memory import (
     InMemoryStoreAdapter,
 )
-from langchain_graph_rag.retrievers.strategy.mmr import (
+from langchain_graph_retriever.retrievers.strategy.mmr import (
     Mmr,
 )
 from tests.embeddings.simple_embeddings import Angular2DEmbeddings

diff --git a/...aph-rag/tests/integration_tests/stores.py → ...triever/tests/integration_tests/stores.py b/...aph-rag/tests/integration_tests/stores.py → ...triever/tests/integration_tests/stores.py
@@ -5,10 +5,10 @@
 from langchain_core.documents import Document
 from langchain_core.embeddings import Embeddings
 from langchain_core.vectorstores import VectorStore
-from langchain_graph_rag.document_transformers.metadata_denormalizer import (
+from langchain_graph_retriever.document_transformers.metadata_denormalizer import (
     MetadataDenormalizer,
 )
-from langchain_graph_rag.retrievers.store_adapters import StoreAdapter
+from langchain_graph_retriever.retrievers.store_adapters import StoreAdapter
 
 ALL_STORES = ["mem_norm", "mem", "astra", "cassandra", "chroma", "opensearch"]
 TESTCONTAINER_STORES = ["cassandra", "opensearch"]
@@ -85,7 +85,7 @@ def _cassandra_store_factory(request: pytest.FixtureRequest):
 
     from cassandra.cluster import Cluster  # type: ignore
     from langchain_community.vectorstores.cassandra import Cassandra
-    from langchain_graph_rag.retrievers.store_adapters.cassandra import (
+    from langchain_graph_retriever.retrievers.store_adapters.cassandra import (
         CassandraStoreAdapter,
     )
 
@@ -148,7 +148,7 @@ def teardown_cassandra(cassandra: Cassandra):
 
 def _opensearch_store_factory(request: pytest.FixtureRequest):
     from langchain_community.vectorstores import OpenSearchVectorSearch
-    from langchain_graph_rag.retrievers.store_adapters.open_search import (
+    from langchain_graph_retriever.retrievers.store_adapters.open_search import (
         OpenSearchStoreAdapter,
     )
 
@@ -201,7 +201,7 @@ def _astra_store_factory(_request: pytest.FixtureRequest) -> StoreFactory:
     from astrapy.authentication import StaticTokenProvider
     from dotenv import load_dotenv
     from langchain_astradb import AstraDBVectorStore
-    from langchain_graph_rag.retrievers.store_adapters.astra import (
+    from langchain_graph_retriever.retrievers.store_adapters.astra import (
         AstraStoreAdapter,
     )
 
@@ -248,7 +248,7 @@ def _in_memory_store_factory(
     _request: pytest.FixtureRequest, support_normalized_metadata: bool
 ) -> StoreFactory:
     from langchain_core.vectorstores import InMemoryVectorStore
-    from langchain_graph_rag.retrievers.store_adapters.in_memory import (
+    from langchain_graph_retriever.retrievers.store_adapters.in_memory import (
         InMemoryStoreAdapter,
     )
 
@@ -269,7 +269,7 @@ def create_in_memory(
 
 def _chroma_store_factory(_request: pytest.FixtureRequest) -> StoreFactory:
     from langchain_chroma.vectorstores import Chroma
-    from langchain_graph_rag.retrievers.store_adapters.chroma import (
+    from langchain_graph_retriever.retrievers.store_adapters.chroma import (
         ChromaStoreAdapter,
     )
 

diff --git a/...unit_tests/retrievers/test_edge_helper.py → ...unit_tests/retrievers/test_edge_helper.py b/...unit_tests/retrievers/test_edge_helper.py → ...unit_tests/retrievers/test_edge_helper.py
@@ -1,6 +1,6 @@
 import pytest
-from langchain_graph_rag.retrievers.edge import Edge
-from langchain_graph_rag.retrievers.edge_helper import EdgeHelper
+from langchain_graph_retriever.retrievers.edge import Edge
+from langchain_graph_retriever.retrievers.edge_helper import EdgeHelper
 
 
 def test_edge_helper_initialization():

diff --git a/...etrievers/test_generic_graph_traversal.py → ...etrievers/test_generic_graph_traversal.py b/...etrievers/test_generic_graph_traversal.py → ...etrievers/test_generic_graph_traversal.py
@@ -1,4 +1,4 @@
-from langchain_graph_rag.retrievers.strategy.mmr import Mmr
+from langchain_graph_retriever.retrievers.strategy.mmr import Mmr
 
 
 def test_mmr_parameters() -> None:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [project]
-name = "graph-rag-workspace"
+name = "graph-retriever-workspace"
 version = "0.1.0"
 description = "uv workspace for Graph RAG projects"
 readme = "README.md"
@@ -41,6 +41,6 @@ skip_empty = true
 [tool.coverage.run]
 branch = true
 source = [
-    "packages/graph-rag/src/graph_rag",
-    "packages/langchain-graph-rag/src/langchain_graph_rag",
+    "packages/graph-retriever/src/graph_retriever",
+    "packages/langchain-graph-retriever/src/langchain_graph_retriever",
     ]
diff --git a/uv.lock b/uv.lock