Merge pull request #14 from blink1073/INTPYTHON-649

blink1073 · web-flow · commit 38b6030fe1c8 · 2025-06-11T09:35:15.000-05:00
INTPYTHON-649 Rename the project to pymongo-voyageai-multimodal
diff --git a/.github/workflows/dist.yml b/.github/workflows/dist.yml
@@ -53,7 +53,7 @@ jobs:
         run: |
           python -m pip install dist/*.gz
           cd ..
-          python -c "from pymongo_voyageai import PyMongoVoyageAI"
+          python -c "from pymongo_voyageai_multimodal import PyMongoVoyageAI"
 
       - uses: actions/upload-artifact@v4
         with:
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# PyMongo-VoyageAI
+# PyMongo-VoyageAI-Multimodal
 
 PyMongo integration with VoyageAI for multimodal embedding.
 
@@ -7,15 +7,15 @@ PyMongo integration with VoyageAI for multimodal embedding.
 Requires Python 3.10+.
 
 ```bash
-pip install --pre pymongo-voyageai
+pip install --pre pymongo-voyageai-multimodal
 ```
 
 ## Quickstart
 
 Obtain an API key for [VoyageAI](https://docs.voyageai.com/docs/api-key-and-installation).
 
 ```python
-from pymongo_voyageai import PyMongoVoyageAI
+from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
 # Create our client.
 client = PyMongoVoyageAI(
diff --git a/docs/api.rst b/docs/api.rst
@@ -4,27 +4,27 @@ API
 Classes
 -------
 
-.. autoclass:: pymongo_voyageai.PyMongoVoyageAI
+.. autoclass:: pymongo_voyageai_multimodal.PyMongoVoyageAI
    :members:
 
    .. automethod:: __init__
 
-.. autoclass:: pymongo_voyageai.ImageDocument
+.. autoclass:: pymongo_voyageai_multimodal.ImageDocument
 
-.. autoclass:: pymongo_voyageai.TextDocument
+.. autoclass:: pymongo_voyageai_multimodal.TextDocument
 
-.. autoclass:: pymongo_voyageai.StoredDocument
+.. autoclass:: pymongo_voyageai_multimodal.StoredDocument
 
-.. autoclass:: pymongo_voyageai.S3Storage
+.. autoclass:: pymongo_voyageai_multimodal.S3Storage
 
     .. automethod:: __init__
 
-.. autoclass:: pymongo_voyageai.MemoryStorage
+.. autoclass:: pymongo_voyageai_multimodal.MemoryStorage
    :members:
 
-.. autoclass:: pymongo_voyageai.ObjectStorage
+.. autoclass:: pymongo_voyageai_multimodal.ObjectStorage
    :members:
 
-.. autoclass:: pymongo_voyageai.DocumentType
+.. autoclass:: pymongo_voyageai_multimodal.DocumentType
 
-.. autoclass:: pymongo_voyageai.Document
+.. autoclass:: pymongo_voyageai_multimodal.Document
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,5 +1,5 @@
 #
-# PyMongo-VoyageAI documentation build configuration file, created by
+# PyMongo-VoyageAI-Multimodal documentation build configuration file, created by
 # sphinx-quickstart on Mon Dec 26 10:16:15 2011.
 #
 # This file is execfile()d with the current directory set to its containing dir.
@@ -18,7 +18,7 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
-from pymongo_voyageai._version import __version__
+from pymongo_voyageai_multimodal._version import __version__
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -54,7 +54,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "PyMongo-VoyageAI"
+project = "PyMongo-VoyageAI-Multimodal"
 copyright = "2025, MongoDB"
 
 # The version info for the project you"re documenting, acts as replacement for
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -7,7 +7,7 @@ Querying Against PDF Pages
 .. code-block:: python
 
     import os
-    from pymongo_voyageai import PyMongoVoyageAI
+    from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
     client = PyMongoVoyageAI(
         voyageai_api_key=os.environ["VOYAGEAI_API_KEY"],
@@ -37,7 +37,7 @@ Querying Against Parquet Data
 .. code-block:: python
 
     import os
-    from pymongo_voyageai import PyMongoVoyageAI
+    from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
     client = PyMongoVoyageAI(
         voyageai_api_key=os.environ["VOYAGEAI_API_KEY"],
@@ -66,7 +66,7 @@ Combining Text and Images
 .. code-block:: python
 
     import os
-    from pymongo_voyageai import PyMongoVoyageAI
+    from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
     client = PyMongoVoyageAI(
         voyageai_api_key=os.environ["VOYAGEAI_API_KEY"],
@@ -105,7 +105,7 @@ If you already have data stored in S3, you can use an ``s3://`` url to load the
 .. code-block:: python
 
     import os
-    from pymongo_voyageai import PyMongoVoyageAI
+    from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
     client = PyMongoVoyageAI(
         voyageai_api_key=os.environ["VOYAGEAI_API_KEY"],
@@ -135,7 +135,7 @@ Using Async API
 .. code-block:: python
 
     import os
-    from pymongo_voyageai import PyMongoVoyageAI
+    from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
     client = PyMongoVoyageAI(
         voyageai_api_key=os.environ["VOYAGEAI_API_KEY"],
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,21 +1,21 @@
-PyMongo-VoyageAI
-================
+PyMongo-VoyageAI-Multimodal
+===========================
 
 
 Quickstart
 ----------
 
-First, install PyMongo-VoyageAI:
+First, install PyMongo-VoyageAI-MultiModal:
 
 .. code-block:: bash
 
-    $ pip install pymongo-voyageai
+    $ pip install pymongo-voyageai-mulitmodal
 
 Then, perform the multi-modal embedding:
 
 .. code-block:: python
 
-    from pymongo_voyageai import PyMongoVoyageAI
+    from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
     # Create our client.
     client = PyMongoVoyageAI(
diff --git a/pymongo_voyageai_multimodal/__init__.py b/pymongo_voyageai_multimodal/__init__.py
diff --git a/pymongo_voyageai_multimodal/_version.py b/pymongo_voyageai_multimodal/_version.py
diff --git a/pymongo_voyageai_multimodal/client.py b/pymongo_voyageai_multimodal/client.py
@@ -57,7 +57,7 @@ class PyMongoVoyageAI:
 
             import os
             from pymongo import MongoClient
-            from pymongo_voyageai import PyMongoVoyageAI
+            from pymongo_voyageai_multimodal import PyMongoVoyageAI
 
             client = PyMongoVoyageAI.from_connection_string(
                 connection_string=os.environ["MONGODB_ATLAS_CONNECTION_STRING"],
@@ -70,7 +70,7 @@ class PyMongoVoyageAI:
     Add Documents:
         .. code-block:: python
 
-            from pymongo_voyageai import TextDocument, ImageDocument
+            from pymongo_voyageai_multimodal import TextDocument, ImageDocument
 
             text = TextDocument(text="foo", metadata={"baz": "bar"})
             images = client.url_to_images(
diff --git a/pymongo_voyageai_multimodal/document.py b/pymongo_voyageai_multimodal/document.py
diff --git a/pymongo_voyageai_multimodal/storage.py b/pymongo_voyageai_multimodal/storage.py
diff --git a/pymongo_voyageai_multimodal/utils.py b/pymongo_voyageai_multimodal/utils.py
@@ -35,7 +35,7 @@ def pdf_data_to_images(
         A list of image objects.
     """
     if fitz is None:
-        raise ValueError("pymongo-voyageai requires PyMuPDF to read pdf files") from None
+        raise ValueError("pymongo-voyageai-multimodal requires PyMuPDF to read pdf files") from None
 
     # Read the PDF from the specified URL
     pdf = fitz.open(stream=pdf_stream, filetype="pdf")
@@ -114,7 +114,9 @@ def url_to_images(
         try:
             import pandas as pd
         except ImportError:
-            raise ValueError("pymongo-voyageai requires pandas to read parquet files") from None
+            raise ValueError(
+                "pymongo-voyageai-multimodal requires pandas to read parquet files"
+            ) from None
         if image_column is None:
             raise ValueError("Must supply and image field to read a parquet file")
         column = pd.read_parquet(source, **kwargs)[image_column][start:end]
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "pymongo-voyageai"
+name = "pymongo-voyageai-multimodal"
 dynamic = ["version"]
 description = "PyMongo integration with VoyageAI for multimodal embedding"
 readme = "README.md"
@@ -36,8 +36,8 @@ dependencies = [
 ]
 
 [project.urls]
-Download = "https://github.com/mongodb-labs/pymongo-voyageai/tags"
-Homepage = "http://pymongo-voyageai.readthedocs.org/"
+Download = "https://github.com/mongodb-labs/pymongo-voyageai-multimodal/tags"
+Homepage = "http://pymongo-voyageai-multimodal.readthedocs.org/"
 
 [dependency-groups]
 dev = [
@@ -57,11 +57,11 @@ dev = [
 
 
 [tool.hatch.version]
-path = "pymongo_voyageai/_version.py"
+path = "pymongo_voyageai_multimodal/_version.py"
 
 [tool.hatch.build.targets.sdist]
 include = [
-    "/pymongo_voyageai",
+    "/pymongo_voyageai_multimodal",
 ]
 
 
diff --git a/tests/test_client_integration.py b/tests/test_client_integration.py
@@ -8,7 +8,7 @@
 import pytest
 from bson import ObjectId
 
-from pymongo_voyageai import MemoryStorage, PyMongoVoyageAI
+from pymongo_voyageai_multimodal import MemoryStorage, PyMongoVoyageAI
 
 if "VOYAGEAI_API_KEY" not in os.environ:
     pytest.skip("Requires VoyageAI API Key.", allow_module_level=True)
diff --git a/tests/test_client_unit.py b/tests/test_client_unit.py
@@ -9,7 +9,7 @@
 import certifi
 import pytest
 
-from pymongo_voyageai import MemoryStorage, PyMongoVoyageAI
+from pymongo_voyageai_multimodal import MemoryStorage, PyMongoVoyageAI
 
 # mypy: disable_error_code="no-untyped-def"
 
diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -1,6 +1,6 @@
 from PIL import Image
 
-from pymongo_voyageai.utils import url_to_images
+from pymongo_voyageai_multimodal.utils import url_to_images
 
 
 def test_url_to_images_parquet():
diff --git a/uv.lock b/uv.lock
