update scripts

objaverse_xl/__init__.py

@@ -1 +1,3 @@
+"""A package for downloading and processing Objaverse-XL."""
+
 from .smithsonian import download_smithsonian_objects, load_smithsonian_metadata

objaverse_xl/github.py

@@ -1,59 +1,4 @@
-"""
-
-- handle_found_object: Called when an object is successfully found and downloaded. Here,
-    the object has the same sha256 as the one that was downloaded with Objaverse-XL. If
-    not specified, the object will be downloaded, but nothing will be done with it.
-
-    Args:
-        file (str): Local path to the downloaded 3D object.
-        github_url (str): GitHub URL of the 3D object.
-        sha256 (str): SHA256 of the contents of the 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object comes from.
-    Returns: Any
-
-- handle_new_object: Called when a new object is found. Here, the object is not used in
-    Objaverse-XL, but is still downloaded with the repository. The object may have not
-    been used because it does not successfully import into Blender. If not specified,
-    the object will be downloaded, but nothing will be done with it.
-
-    Args:
-        file (str): Local path to the downloaded 3D object.
-        github_url (str): GitHub URL of the 3D object.
-        sha256 (str): SHA256 of the contents of the 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object comes from.
-    Returns: Any
-
-- handle_modified_object: Called when a modified object is found and downloaded. Here,
-    the object is successfully downloaded, but it has a different sha256 than the one
-    that was downloaded with Objaverse-XL. This is not expected to happen very often,
-    because the same commit hash is used for each repo. If not specified, the object
-    will be downloaded, but nothing will be done with it.
-
-    Args:
-        file (str): Local path to the downloaded 3D object.
-        github_url (str): GitHub URL of the 3D object.
-        sha256 (str): SHA256 of the contents of the 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object comes from.
-    Returns: Any
-
-- handle_missing_object: Called when an object that is in Objaverse-XL is not found.
-    Here, it is likely that the repository was deleted or renamed. If not specified, the
-    object will be downloaded, but nothing will be done with it.
-
-    Args:
-        github_url (str): GitHub URL of the 3D object.
-        sha256 (str): SHA256 of the contents of the original 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object comes from.
-    Returns: Any
-
-
-Note: You'll likely find more objects by 
-
-"""
+"""Script to download objects from GitHub."""
 
 import hashlib
 import json
@@ -430,6 +375,56 @@ def download_github_objects(
             If None, will use the number of CPUs on the machine. Defaults to None.
         download_dir (str, optional): Directory to download the GitHub objects to.
             Supports all file systems supported by fsspec. Defaults to "~/.objaverse".
+        save_repo_format (Optional[Literal["zip", "tar", "tar.gz", "files"]], optional):
+            Format to save the repository. If None, the repository will not be saved. If
+            "files" is specified, each file will be saved individually. Otherwise, the
+            repository can be saved as a "zip", "tar", or "tar.gz" file. Defaults to
+            None.
+        handle_found_object (Optional[Callable], optional): Called when an object is
+            successfully found and downloaded. Here, the object has the same sha256 as
+            the one that was downloaded with Objaverse-XL. If None, the object will be
+            downloaded, but nothing will be done with it. Args for the function include:
+            - file (str): Local path to the downloaded 3D object.
+            - github_url (str): GitHub URL of the 3D object.
+            - sha256 (str): SHA256 of the contents of the 3D object.
+            - repo (str): Name of the GitHub repo where the 3D object comes from.
+            - organization (str): Name of the GitHub organization where the 3D object
+                comes from.
+            Return is not used. Defaults to None.
+        handle_new_object (Optional[Callable], optional): Called when a new object is
+            found. Here, the object is not used in Objaverse-XL, but is still downloaded
+            with the repository. The object may have not been used because it does not
+            successfully import into Blender. If None, the object will be downloaded,
+            but nothing will be done with it. Args for the function include:
+            - file (str): Local path to the downloaded 3D object.
+            - github_url (str): GitHub URL of the 3D object.
+            - sha256 (str): SHA256 of the contents of the 3D object.
+            - repo (str): Name of the GitHub repo where the 3D object comes from.
+            - organization (str): Name of the GitHub organization where the 3D object
+                comes from.
+            Return is not used. Defaults to None.
+        handle_modified_object (Optional[Callable], optional): Called when a modified
+            object is found and downloaded. Here, the object is successfully downloaded,
+            but it has a different sha256 than the one that was downloaded with
+            Objaverse-XL. This is not expected to happen very often, because the same
+            commit hash is used for each repo. If None, the object will be downloaded,
+            but nothing will be done with it. Args for the function include:
+            - file (str): Local path to the downloaded 3D object.
+            - github_url (str): GitHub URL of the 3D object.
+            - sha256 (str): SHA256 of the contents of the 3D object.
+            - repo (str): Name of the GitHub repo where the 3D object comes from.
+            - organization (str): Name of the GitHub organization where the 3D object
+                comes from.
+            Return is not used. Defaults to None.
+        handle_missing_object (Optional[Callable], optional): Called when an object that
+            is in Objaverse-XL is not found. Here, it is likely that the repository was
+            deleted or renamed. If None, nothing will be done with the missing object.
+            Args for the function include:
+            - github_url (str): GitHub URL of the 3D object.
+            - sha256 (str): SHA256 of the contents of the original 3D object.
+            - repo (str): Name of the GitHub repo where the 3D object comes from.
+            - organization (str): Name of the GitHub organization where the 3D object comes from.
+            Return is not used. Defaults to None.
 
     Returns:
         List[Dict[str, str]]: List of dictionaries with the keys "githubUrl" and

objaverse_xl/objaverse_v1.py

@@ -1,3 +1,5 @@
+"""Script to download objects from Objaverse 1.0."""
+
 import gzip
 import json
 import os

objaverse_xl/smithsonian.py

@@ -1,3 +1,5 @@
+"""Script to download 3D objects from the Smithsonian Institution."""
+
 import multiprocessing
 import os
 from functools import partial

objaverse_xl/thingiverse.py

@@ -1,3 +1,5 @@
+"""Script to download objects from Thingiverse."""
+
 import multiprocessing
 import os
 import time

objaverse_xl/utils.py

@@ -1,3 +1,5 @@
+"""Utility functions for the objaverse_xl package."""
+
 import uuid