INTPYTHON-649 Rename the project to pymongo-voyageai-multimodal

Author: blink1073

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(

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

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

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(

pymongo_voyageai/__init__.py renamed to pymongo_voyageai_multimodal/__init__.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(

pymongo_voyageai/_version.py renamed to pymongo_voyageai_multimodal/_version.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]