cleanup code

.github/workflows/ci.yaml

@@ -0,0 +1,51 @@
+name: Continuous integration
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Install
+        run: |
+          python3 -m venv .env
+          source .env/bin/activate
+          python -m pip install -U pip
+          make install-dev
+      - name: Lint
+        run: |
+          source .env/bin/activate
+          make lint
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install
+      run: |
+        python3 -m venv .env
+        source .env/bin/activate
+        make install
+        make install-dev
+    - name: Unit tests
+      run: |
+        source .env/bin/activate
+        make test

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+profile = black
+known_third_party = pandas,numpy  # Modify with your actual third party libraries

.pylintrc

@@ -0,0 +1,331 @@
+[MASTER]
+
+# Specify a configuration file.
+#rcfile=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Profiled execution.
+profile=no
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+
+[MESSAGES CONTROL]
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time. See also the "--disable" option for examples.
+enable=indexing-exception,old-raise-syntax
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once).You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use"--disable=all --enable=classes
+# --disable=W"
+disable=design,similarities,no-self-use,attribute-defined-outside-init,locally-disabled,star-args,pointless-except,bad-option-value,global-statement,fixme,suppressed-message,useless-suppression,locally-enabled,no-member,no-name-in-module,import-error,unsubscriptable-object,unbalanced-tuple-unpacking,undefined-variable,not-context-manager,no-else-return,wrong-import-order,unnecessary-pass,logging-fstring-interpolation,logging-format-interpolation,C0330
+
+
+# Set the cache size for astng objects.
+cache-size=500
+
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html. You can also give a reporter class, eg
+# mypackage.mymodule.MyReporterClass.
+output-format=text
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]".
+files-output=no
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Add a comment according to your evaluation note. This is used by the global
+# evaluation report (RP0004).
+comment=no
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details
+#msg-template=
+
+
+[TYPECHECK]
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+ignored-classes=SQLObject
+
+# When zope mode is activated, add a predefined set of Zope acquired attributes
+# to generated-members.
+zope=no
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E0201 when accessed. Python regular
+# expressions are accepted.
+generated-members=REQUEST,acl_users,aq_parent
+
+# List of decorators that create context managers from functions, such as
+# contextlib.contextmanager.
+contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the beginning of the name of dummy variables
+# (i.e. not used).
+dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_)
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+
+[BASIC]
+
+# Required attributes for module, separated by a comma
+required-attributes=
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=apply,input,reduce
+
+
+# Disable the report(s) with the given id(s).
+# All non-Google reports are disabled by default.
+disable-report=R0001,R0002,R0003,R0004,R0101,R0102,R0201,R0202,R0220,R0401,R0402,R0701,R0801,R0901,R0902,R0903,R0904,R0911,R0912,R0913,R0914,R0915,R0921,R0922,R0923
+
+# Regular expression which should only match correct module names
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Regular expression which should only match correct module level names
+const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$
+
+# Regular expression which should only match correct class names
+class-rgx=^_?[A-Z][a-zA-Z0-9]*$
+
+# Regular expression which should only match correct function names
+function-rgx=^(?:(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$
+
+# Regular expression which should only match correct method names
+method-rgx=^(?:(?P<exempt>__[a-z0-9_]+__|next)|(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$
+
+# Regular expression which should only match correct instance attribute names
+attr-rgx=^_{0,2}[a-z][a-z0-9_]*$
+
+# Regular expression which should only match correct argument names
+argument-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression which should only match correct variable names
+variable-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression which should only match correct attribute names in class
+# bodies
+class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$
+
+# Regular expression which should only match correct list comprehension /
+# generator expression variable names
+inlinevar-rgx=^[a-z][a-z0-9_]*$
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=main,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=(__.*__|main)
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=10
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=(?x)
+  (^\s*(import|from)\s
+   |\$Id:\s\/\/depot\/.+#\d+\s\$
+   |^[a-zA-Z_][a-zA-Z0-9_]*\s*=\s*("[^"]\S+"|'[^']\S+')
+   |^\s*\#\ LINT\.ThenChange
+   |^[^#]*\#\ type:\ [a-zA-Z_][a-zA-Z0-9_.,[\] ]*$
+   |pylint
+   |"""
+   |\#
+   |lambda
+   |(https?|ftp):)
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=y
+
+# List of optional constructs for which whitespace checking is disabled
+no-space-check=
+
+# Maximum number of lines in a module
+max-module-lines=99999
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,TERMIOS,Bastion,rexec,sets
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled)
+import-graph=
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+
+extension-pkg-whitelist=_jsonnet
+
+
+[CLASSES]
+
+# List of interface methods to ignore, separated by a comma. This is used for
+# instance to not check methods defines in Zope's Interface base class.
+ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,setUp
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls,class_
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore
+ignored-argument-names=_.*
+
+# Maximum number of locals for function / method body
+max-locals=15
+
+# Maximum number of return / yield for function / method body
+max-returns=6
+
+# Maximum number of branch for function / method body
+max-branches=12
+
+# Maximum number of statements in function / method body
+max-statements=50
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception,StandardError,BaseException
+
+
+[AST]
+
+# Maximum line length for lambdas
+short-func-length=1
+
+# List of module members that should be marked as deprecated.
+# All of the string functions are listed in 4.1.4 Deprecated string functions
+# in the Python 2.4 docs.
+deprecated-members=string.atof,string.atoi,string.atol,string.capitalize,string.expandtabs,string.find,string.rfind,string.index,string.rindex,string.count,string.lower,string.split,string.rsplit,string.splitfields,string.join,string.joinfields,string.lstrip,string.rstrip,string.strip,string.swapcase,string.translate,string.upper,string.ljust,string.rjust,string.center,string.zfill,string.replace,sys.exitfunc
+
+
+[DOCSTRING]
+
+# List of exceptions that do not need to be mentioned in the Raises section of
+# a docstring.
+ignore-exceptions=AssertionError,NotImplementedError,StopIteration,TypeError
+
+
+
+[TOKENS]
+
+# Number of spaces of indent required when the last token on the preceding line
+# is an open (, [, or {.
+indent-after-paren=4

Makefile

@@ -0,0 +1,24 @@
+install: ## [Local development] Upgrade pip, install requirements, install package.
+	python -m pip install -U pip
+	python -m pip install -e .
+
+install-dev: ## [Local development] Install test requirements
+	python -m pip install -r requirements-test.txt
+
+lint: ## [Local development] Run mypy, pylint and black
+	python -m mypy objaverse_xl
+	python -m pylint objaverse_xl
+	python -m black --check objaverse_xl
+	python -m isort --check-only objaverse_xl
+
+format: ## [Local development] Auto-format python code using black
+	python -m isort objaverse_xl
+	python -m black objaverse_xl
+
+test: ## [Local development] Run unit tests
+	python -m pytest -x -s -v tests
+
+.PHONY: help
+
+help: # Run `make help` to get help on the make commands
+	@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

mypy.ini

@@ -0,0 +1,5 @@
+# Global options:
+
+[mypy]
+python_version = 3.8
+ignore_missing_imports = True

objaverse_xl/__init__.py

@@ -1 +1 @@
-from smithsonian import download_smithsonian_objects, load_smithsonian_metadata
+from .smithsonian import download_smithsonian_objects, load_smithsonian_metadata

objaverse_xl/github.py

@@ -55,22 +55,24 @@ Note: You'll likely find more objects by
 
 """
 
-# %%
-import shutil
+import hashlib
 import json
-import pandas as pd
-from typing import Dict, List, Optional, Literal, Callable
-from tqdm import tqdm
+import multiprocessing
 import os
+
+# %%
+import shutil
+import subprocess
 import tarfile
+import tempfile
+from multiprocessing import Pool
+from typing import Callable, Dict, List, Literal, Optional
+
 import fsspec
+import pandas as pd
 import requests
-import tempfile
-import subprocess
 from loguru import logger
-import hashlib
-from multiprocessing import Pool
-import multiprocessing
+from tqdm import tqdm
 
 FILE_EXTENSIONS = [
     ".obj",
@@ -410,9 +412,6 @@ def _process_group(group):
     return key, group_df.set_index("githubUrl")["sha256"].to_dict()
 
 
-# %%
-
-
 def download_github_objects(
     objects: pd.DataFrame,
     processes: Optional[int] = None,
@@ -529,510 +528,3 @@ def download_github_objects(
         )
     out_list = [item for sublist in out for item in sublist]
     return out_list
-
-
-def test_process_repo():
-    download_dir = "~/.objaverse-tests"
-    base_download_dir = os.path.join(download_dir, "github")
-    fs, path = fsspec.core.url_to_fs(base_download_dir)
-    fs.makedirs(path, exist_ok=True)
-
-    for save_repo_format in ["tar", "tar.gz", "zip", "files"]:
-        # shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-        out = _process_repo(
-            repo_id="mattdeitke/objaverse-xl-test-files",
-            fs=fs,
-            base_dir=path,
-            save_repo_format=save_repo_format,  # type: ignore
-            expected_objects=dict(),
-            handle_found_object=None,
-            handle_modified_object=None,
-            handle_missing_object=None,
-            handle_new_object=None,
-            commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
-        )
-
-        # test that the sha256's are correct
-        assert len(out) == 3
-        sha256s = [x["sha256"] for x in out]
-        for sha256 in [
-            "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-            "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-            "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
-        ]:
-            assert sha256 in sha256s, f"{sha256=} not in {sha256s=}"
-        github_urls = [x["githubUrl"] for x in out]
-        for github_url in [
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj",
-        ]:
-            assert github_url in github_urls, f"{github_url=} not in {github_urls=}"
-
-        # test that the files are correct
-        if save_repo_format != "files":
-            assert fs.exists(
-                os.path.join(
-                    path,
-                    "repos",
-                    "mattdeitke",
-                    f"objaverse-xl-test-files.{save_repo_format}",
-                )
-            )
-        else:
-            assert fs.exists(
-                os.path.join(
-                    base_download_dir, "repos", "mattdeitke", "objaverse-xl-test-files"
-                )
-            )
-
-
-def test_handle_new_object():
-    found_objects = []
-    handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    missing_objects = []
-    handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
-            dict(
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    new_objects = []
-    handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    download_dir = "~/.objaverse-tests"
-    base_download_dir = os.path.join(download_dir, "github")
-    fs, path = fsspec.core.url_to_fs(base_download_dir)
-    fs.makedirs(path, exist_ok=True)
-
-    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
-        repo_id="mattdeitke/objaverse-xl-test-files",
-        fs=fs,
-        base_dir=path,
-        save_repo_format=None,
-        expected_objects=dict(),
-        handle_found_object=handle_found_object,
-        handle_modified_object=handle_modified_object,
-        handle_missing_object=handle_missing_object,
-        handle_new_object=handle_new_object,
-        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
-    )
-
-    assert len(out) == 3
-    assert len(new_objects) == 3
-    assert len(found_objects) == 0
-    assert len(modified_objects) == 0
-    assert len(missing_objects) == 0
-
-
-def test_handle_found_object():
-    found_objects = []
-    handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    missing_objects = []
-    handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
-            dict(
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    new_objects = []
-    handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    download_dir = "~/.objaverse-tests"
-    base_download_dir = os.path.join(download_dir, "github")
-    fs, path = fsspec.core.url_to_fs(base_download_dir)
-    fs.makedirs(path, exist_ok=True)
-
-    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
-        repo_id="mattdeitke/objaverse-xl-test-files",
-        fs=fs,
-        base_dir=path,
-        save_repo_format=None,
-        expected_objects={
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-        },
-        handle_found_object=handle_found_object,
-        handle_modified_object=handle_modified_object,
-        handle_missing_object=handle_missing_object,
-        handle_new_object=handle_new_object,
-        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
-    )
-
-    assert len(out) == 3
-    assert len(found_objects) == 3
-    assert len(missing_objects) == 0
-    assert len(new_objects) == 0
-    assert len(modified_objects) == 0
-
-
-def test_handle_modified_object():
-    found_objects = []
-    handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    missing_objects = []
-    handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
-            dict(
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    new_objects = []
-    handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    download_dir = "~/.objaverse-tests"
-    base_download_dir = os.path.join(download_dir, "github")
-    fs, path = fsspec.core.url_to_fs(base_download_dir)
-    fs.makedirs(path, exist_ok=True)
-
-    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
-        repo_id="mattdeitke/objaverse-xl-test-files",
-        fs=fs,
-        base_dir=path,
-        save_repo_format=None,
-        expected_objects={
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9<modified>",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-        },
-        handle_found_object=handle_found_object,
-        handle_modified_object=handle_modified_object,
-        handle_missing_object=handle_missing_object,
-        handle_new_object=handle_new_object,
-        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
-    )
-
-    assert len(out) == 3
-    assert len(found_objects) == 2
-    assert len(missing_objects) == 0
-    assert len(new_objects) == 0
-    assert len(modified_objects) == 1
-
-
-def test_handle_missing_object():
-    found_objects = []
-    handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    missing_objects = []
-    handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
-            dict(
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    new_objects = []
-    handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    download_dir = "~/.objaverse-tests"
-    base_download_dir = os.path.join(download_dir, "github")
-    fs, path = fsspec.core.url_to_fs(base_download_dir)
-    fs.makedirs(path, exist_ok=True)
-
-    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
-        repo_id="mattdeitke/objaverse-xl-test-files",
-        fs=fs,
-        base_dir=path,
-        save_repo_format=None,
-        expected_objects={
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example-2.fbx": "<fake-missing-object>",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-        },
-        handle_found_object=handle_found_object,
-        handle_modified_object=handle_modified_object,
-        handle_missing_object=handle_missing_object,
-        handle_new_object=handle_new_object,
-        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
-    )
-
-    assert len(out) == 3
-    assert len(found_objects) == 3
-    assert len(missing_objects) == 1
-    assert len(new_objects) == 0
-    assert len(modified_objects) == 0
-
-
-def test_handle_missing_object_2():
-    found_objects = []
-    handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    missing_objects = []
-    handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
-            dict(
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    new_objects = []
-    handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
-        )
-    )
-
-    download_dir = "~/.objaverse-tests"
-    base_download_dir = os.path.join(download_dir, "github")
-    fs, path = fsspec.core.url_to_fs(base_download_dir)
-    fs.makedirs(path, exist_ok=True)
-
-    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
-        repo_id="mattdeitke/objaverse-xl-test-files-does-not-exist",
-        fs=fs,
-        base_dir=path,
-        save_repo_format=None,
-        expected_objects={
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example-2.fbx": "<fake-missing-object>",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-        },
-        handle_found_object=handle_found_object,
-        handle_modified_object=handle_modified_object,
-        handle_missing_object=handle_missing_object,
-        handle_new_object=handle_new_object,
-        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
-    )
-
-    assert len(out) == 0
-    assert len(found_objects) == 0
-    assert len(missing_objects) == 4
-    assert len(new_objects) == 0
-    assert len(modified_objects) == 0
-
-
-def test_download_cache():
-    objects = pd.DataFrame(
-        [
-            {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
-                "license": None,
-                "sha256": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
-            },
-            {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
-                "license": None,
-                "sha256": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-            },
-            {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj",
-                "license": None,
-                "sha256": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-            },
-        ]
-    )
-
-    # remove the repos directory
-    for save_repo_format in ["tar", "tar.gz", "zip", "files"]:
-        repos_dir = "~/.objaverse-tests/github/repos"
-        shutil.rmtree(os.path.expanduser(repos_dir), ignore_errors=True)
-
-        out = download_github_objects(
-            objects=objects,
-            processes=1,
-            download_dir="~/.objaverse-tests",
-            save_repo_format=save_repo_format,  # type: ignore
-        )
-        assert len(out) == 3
-
-        out = download_github_objects(
-            objects=objects,
-            processes=1,
-            download_dir="~/.objaverse-tests",
-            save_repo_format=save_repo_format,  # type: ignore
-        )
-        assert len(out) == 0

objaverse_xl/objaverse_v1.py

@@ -21,7 +21,7 @@ def load_annotations(
             the metadata for all uids.
         download_dir: The base directory to download the annotations to. Supports all
             file systems supported by fsspec. Defaults to "~/.objaverse".
-    
+
     Returns:
         A list of dictionaries with the metadata for each object. The keys are the uids
         and the values are the metadata for that object.
@@ -40,12 +40,16 @@ def load_annotations(
     )
 
     # get the existing metadata files
-    existing_metadata_files = fs.glob(os.path.join(metadata_path, "*.json.gz"), refresh=True)
-    existing_dir_ids = set([
-        file.split("/")[-1].split(".")[0]
-        for file in existing_metadata_files
-        if file.endswith(".json.gz")  # note partial files end with .json.gz.tmp
-    ])
+    existing_metadata_files = fs.glob(
+        os.path.join(metadata_path, "*.json.gz"), refresh=True
+    )
+    existing_dir_ids = set(
+        [
+            file.split("/")[-1].split(".")[0]
+            for file in existing_metadata_files
+            if file.endswith(".json.gz")  # note partial files end with .json.gz.tmp
+        ]
+    )
     downloaded_dir_ids = existing_dir_ids.intersection(dir_ids)
     logger.info(f"Found {len(downloaded_dir_ids)} metadata files already downloaded")
 
@@ -89,8 +93,10 @@ def load_annotations(
 
     return out
 
+
 annotations = load_annotations(download_dir="~/.objaverse-temp-400")
 
+
 def _load_object_paths(download_dir: str) -> Dict[str, str]:
     """Load the object paths from the dataset.
 
@@ -152,9 +158,7 @@ def _download_object(
     Returns:
         A tuple of the uid and the path to where the downloaded object.
     """
-    hf_url = (
-        f"https://huggingface.co/datasets/allenai/objaverse/resolve/main/{hf_object_path}"
-    )
+    hf_url = f"https://huggingface.co/datasets/allenai/objaverse/resolve/main/{hf_object_path}"
 
     filename = os.path.join(download_dir, "hf-objaverse-v1", hf_object_path)
     fs, path = fsspec.core.url_to_fs(filename)
@@ -203,12 +207,16 @@ def load_objects(
     # file. `glob()` is like walk, but returns a list of files instead of the nested
     # directory structure. glob() is also faster than find() / walk() since it doesn't
     # need to traverse the entire directory structure.
-    existing_file_paths = fs.glob(os.path.join(path, "glbs", "*", "*.glb"), refresh=True)
-    existing_uids = set([
-        file.split("/")[-1].split(".")[0]
-        for file in existing_file_paths
-        if file.endswith(".glb")  # note partial files end with .glb.tmp
-    ])
+    existing_file_paths = fs.glob(
+        os.path.join(path, "glbs", "*", "*.glb"), refresh=True
+    )
+    existing_uids = set(
+        [
+            file.split("/")[-1].split(".")[0]
+            for file in existing_file_paths
+            if file.endswith(".glb")  # note partial files end with .glb.tmp
+        ]
+    )
 
     # add the existing downloaded uids to the return dict
     out = {}
@@ -217,7 +225,7 @@ def load_objects(
         hf_object_path = hf_object_paths[uid]
         fs_abs_object_path = os.path.join(versioned_dirname, hf_object_path)
         out[uid] = fs_abs_object_path
-    
+
     logger.info(f"Found {len(already_downloaded_uids)} objects already downloaded")
 
     # get the uids that need to be downloaded
@@ -251,7 +259,10 @@ def load_objects(
         # download the objects in parallel
         with Pool(download_processes) as pool:
             new_object_downloads = list(
-                tqdm(pool.imap_unordered(_parallel_download_object, args), total=len(args))
+                tqdm(
+                    pool.imap_unordered(_parallel_download_object, args),
+                    total=len(args),
+                )
             )
 
         for uid, local_path in new_object_downloads:
@@ -274,7 +285,9 @@ def load_lvis_annotations(download_dir: str = "~/.objaverse") -> Dict[str, List[
     """
     hf_url = f"https://huggingface.co/datasets/allenai/objaverse/resolve/main/lvis-annotations.json.gz"
 
-    download_path = os.path.join(download_dir, "hf-objaverse-v1", "lvis-annotations.json.gz")
+    download_path = os.path.join(
+        download_dir, "hf-objaverse-v1", "lvis-annotations.json.gz"
+    )
 
     # use fsspec
     fs, path = fsspec.core.url_to_fs(download_path)

objaverse_xl/smithsonian.py

@@ -9,7 +9,8 @@ import pandas as pd
 import requests
 from loguru import logger
 from tqdm import tqdm
-from utils import get_uid_from_str
+
+from .utils import get_uid_from_str
 
 
 def load_smithsonian_metadata(download_dir: str = "~/.objaverse") -> pd.DataFrame:

objaverse_xl/thingiverse.py

@@ -1,14 +1,14 @@
-import os
 import multiprocessing
+import os
+import time
 from multiprocessing import Pool
 from typing import Dict, List, Optional
 
 import fsspec
+import pandas as pd
 import requests
 from loguru import logger
-import pandas as pd
 from tqdm import tqdm
-import time
 
 
 def _get_response_with_retries(
@@ -20,7 +20,7 @@ def _get_response_with_retries(
         url (str): The URL to get a response from.
         max_retries (int, optional): The maximum number of retries. Defaults to 3.
         retry_delay (int, optional): The delay between retries in seconds. Defaults to 5.
-    
+
     Returns:
         Optional[requests.models.Response]: The response from the URL. If there was an error, returns None.
     """
@@ -159,7 +159,10 @@ def download_thingiverse_objects(
             file_path = _download_item(item=item, download_dir=download_dir)
             if file_path is not None:
                 out.append(
-                    {"filePath": file_path, **item,}
+                    {
+                        "filePath": file_path,
+                        **item,
+                    }
                 )
     else:
         args = [(item, download_dir) for item in items_to_download]
@@ -173,7 +176,10 @@ def download_thingiverse_objects(
             )
         out.extend(
             [
-                {"filePath": file_path, **item,}
+                {
+                    "filePath": file_path,
+                    **item,
+                }
                 for item, file_path in items_and_file_paths
                 if file_path is not None
             ]

requirements-test.txt

@@ -0,0 +1,8 @@
+black==22.3.0
+mypy==0.942
+pylint==2.13.4
+pytest-cov==3.0.0
+pytest-xdist==2.5.0
+pytest==7.0.1
+isort==5.12.0
+types-requests==2.31.0.2

setup.py

@@ -23,7 +23,5 @@ setup(
         "License :: OSI Approved :: Apache Software License",
     ],
     install_requires=requirements,
-    extras_require={
-        "s3": ["s3fs==0.4.2"]
-    }
+    extras_require={"s3": ["s3fs==0.4.2"]},
 )

tests/test_api.py

@@ -0,0 +1,519 @@
+import os
+import shutil
+
+import fsspec
+import pandas as pd
+import pytest
+
+from objaverse_xl.github import _process_repo, download_github_objects
+
+# @pytest.mark.parametrize("message", ["hello", "world"])
+# def test_hello_world(message):
+#     hello_world(message)
+
+
+def test_github_process_repo():
+    download_dir = "~/.objaverse-tests"
+    base_download_dir = os.path.join(download_dir, "github")
+    fs, path = fsspec.core.url_to_fs(base_download_dir)
+    fs.makedirs(path, exist_ok=True)
+
+    for save_repo_format in ["tar", "tar.gz", "zip", "files"]:
+        # shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
+        out = _process_repo(
+            repo_id="mattdeitke/objaverse-xl-test-files",
+            fs=fs,
+            base_dir=path,
+            save_repo_format=save_repo_format,  # type: ignore
+            expected_objects=dict(),
+            handle_found_object=None,
+            handle_modified_object=None,
+            handle_missing_object=None,
+            handle_new_object=None,
+            commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
+        )
+
+        # test that the sha256's are correct
+        assert len(out) == 3
+        sha256s = [x["sha256"] for x in out]
+        for sha256 in [
+            "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
+            "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
+            "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
+        ]:
+            assert sha256 in sha256s, f"{sha256=} not in {sha256s=}"
+        github_urls = [x["githubUrl"] for x in out]
+        for github_url in [
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj",
+        ]:
+            assert github_url in github_urls, f"{github_url=} not in {github_urls=}"
+
+        # test that the files are correct
+        if save_repo_format != "files":
+            assert fs.exists(
+                os.path.join(
+                    path,
+                    "repos",
+                    "mattdeitke",
+                    f"objaverse-xl-test-files.{save_repo_format}",
+                )
+            )
+        else:
+            assert fs.exists(
+                os.path.join(
+                    base_download_dir, "repos", "mattdeitke", "objaverse-xl-test-files"
+                )
+            )
+
+
+def test_github_handle_new_object():
+    found_objects = []
+    handle_found_object = (
+        lambda file, github_url, sha256, repo, organization: found_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    missing_objects = []
+    handle_missing_object = (
+        lambda github_url, sha256, repo, organization: missing_objects.append(
+            dict(
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    new_objects = []
+    handle_new_object = (
+        lambda file, github_url, sha256, repo, organization: new_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    modified_objects = []
+    handle_modified_object = (
+        lambda file, github_url, sha256, repo, organization: modified_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    download_dir = "~/.objaverse-tests"
+    base_download_dir = os.path.join(download_dir, "github")
+    fs, path = fsspec.core.url_to_fs(base_download_dir)
+    fs.makedirs(path, exist_ok=True)
+
+    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
+    out = _process_repo(
+        repo_id="mattdeitke/objaverse-xl-test-files",
+        fs=fs,
+        base_dir=path,
+        save_repo_format=None,
+        expected_objects=dict(),
+        handle_found_object=handle_found_object,
+        handle_modified_object=handle_modified_object,
+        handle_missing_object=handle_missing_object,
+        handle_new_object=handle_new_object,
+        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
+    )
+
+    assert len(out) == 3
+    assert len(new_objects) == 3
+    assert len(found_objects) == 0
+    assert len(modified_objects) == 0
+    assert len(missing_objects) == 0
+
+
+def test_github_handle_found_object():
+    found_objects = []
+    handle_found_object = (
+        lambda file, github_url, sha256, repo, organization: found_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    missing_objects = []
+    handle_missing_object = (
+        lambda github_url, sha256, repo, organization: missing_objects.append(
+            dict(
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    new_objects = []
+    handle_new_object = (
+        lambda file, github_url, sha256, repo, organization: new_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    modified_objects = []
+    handle_modified_object = (
+        lambda file, github_url, sha256, repo, organization: modified_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    download_dir = "~/.objaverse-tests"
+    base_download_dir = os.path.join(download_dir, "github")
+    fs, path = fsspec.core.url_to_fs(base_download_dir)
+    fs.makedirs(path, exist_ok=True)
+
+    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
+    out = _process_repo(
+        repo_id="mattdeitke/objaverse-xl-test-files",
+        fs=fs,
+        base_dir=path,
+        save_repo_format=None,
+        expected_objects={
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
+        },
+        handle_found_object=handle_found_object,
+        handle_modified_object=handle_modified_object,
+        handle_missing_object=handle_missing_object,
+        handle_new_object=handle_new_object,
+        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
+    )
+
+    assert len(out) == 3
+    assert len(found_objects) == 3
+    assert len(missing_objects) == 0
+    assert len(new_objects) == 0
+    assert len(modified_objects) == 0
+
+
+def test_github_handle_modified_object():
+    found_objects = []
+    handle_found_object = (
+        lambda file, github_url, sha256, repo, organization: found_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    missing_objects = []
+    handle_missing_object = (
+        lambda github_url, sha256, repo, organization: missing_objects.append(
+            dict(
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    new_objects = []
+    handle_new_object = (
+        lambda file, github_url, sha256, repo, organization: new_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    modified_objects = []
+    handle_modified_object = (
+        lambda file, github_url, sha256, repo, organization: modified_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    download_dir = "~/.objaverse-tests"
+    base_download_dir = os.path.join(download_dir, "github")
+    fs, path = fsspec.core.url_to_fs(base_download_dir)
+    fs.makedirs(path, exist_ok=True)
+
+    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
+    out = _process_repo(
+        repo_id="mattdeitke/objaverse-xl-test-files",
+        fs=fs,
+        base_dir=path,
+        save_repo_format=None,
+        expected_objects={
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9<modified>",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
+        },
+        handle_found_object=handle_found_object,
+        handle_modified_object=handle_modified_object,
+        handle_missing_object=handle_missing_object,
+        handle_new_object=handle_new_object,
+        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
+    )
+
+    assert len(out) == 3
+    assert len(found_objects) == 2
+    assert len(missing_objects) == 0
+    assert len(new_objects) == 0
+    assert len(modified_objects) == 1
+
+
+def test_github_handle_missing_object():
+    found_objects = []
+    handle_found_object = (
+        lambda file, github_url, sha256, repo, organization: found_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    missing_objects = []
+    handle_missing_object = (
+        lambda github_url, sha256, repo, organization: missing_objects.append(
+            dict(
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    new_objects = []
+    handle_new_object = (
+        lambda file, github_url, sha256, repo, organization: new_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    modified_objects = []
+    handle_modified_object = (
+        lambda file, github_url, sha256, repo, organization: modified_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    download_dir = "~/.objaverse-tests"
+    base_download_dir = os.path.join(download_dir, "github")
+    fs, path = fsspec.core.url_to_fs(base_download_dir)
+    fs.makedirs(path, exist_ok=True)
+
+    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
+    out = _process_repo(
+        repo_id="mattdeitke/objaverse-xl-test-files",
+        fs=fs,
+        base_dir=path,
+        save_repo_format=None,
+        expected_objects={
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example-2.fbx": "<fake-missing-object>",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
+        },
+        handle_found_object=handle_found_object,
+        handle_modified_object=handle_modified_object,
+        handle_missing_object=handle_missing_object,
+        handle_new_object=handle_new_object,
+        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
+    )
+
+    assert len(out) == 3
+    assert len(found_objects) == 3
+    assert len(missing_objects) == 1
+    assert len(new_objects) == 0
+    assert len(modified_objects) == 0
+
+
+def test_github_handle_missing_object_2():
+    found_objects = []
+    handle_found_object = (
+        lambda file, github_url, sha256, repo, organization: found_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    missing_objects = []
+    handle_missing_object = (
+        lambda github_url, sha256, repo, organization: missing_objects.append(
+            dict(
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    new_objects = []
+    handle_new_object = (
+        lambda file, github_url, sha256, repo, organization: new_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    modified_objects = []
+    handle_modified_object = (
+        lambda file, github_url, sha256, repo, organization: modified_objects.append(
+            dict(
+                file=file,
+                github_url=github_url,
+                sha256=sha256,
+                repo=repo,
+                organization=organization,
+            )
+        )
+    )
+
+    download_dir = "~/.objaverse-tests"
+    base_download_dir = os.path.join(download_dir, "github")
+    fs, path = fsspec.core.url_to_fs(base_download_dir)
+    fs.makedirs(path, exist_ok=True)
+
+    shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
+    out = _process_repo(
+        repo_id="mattdeitke/objaverse-xl-test-files-does-not-exist",
+        fs=fs,
+        base_dir=path,
+        save_repo_format=None,
+        expected_objects={
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example-2.fbx": "<fake-missing-object>",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
+            "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
+        },
+        handle_found_object=handle_found_object,
+        handle_modified_object=handle_modified_object,
+        handle_missing_object=handle_missing_object,
+        handle_new_object=handle_new_object,
+        commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
+    )
+
+    assert len(out) == 0
+    assert len(found_objects) == 0
+    assert len(missing_objects) == 4
+    assert len(new_objects) == 0
+    assert len(modified_objects) == 0
+
+
+def test_github_download_cache():
+    objects = pd.DataFrame(
+        [
+            {
+                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
+                "license": None,
+                "sha256": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
+            },
+            {
+                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
+                "license": None,
+                "sha256": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
+            },
+            {
+                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj",
+                "license": None,
+                "sha256": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
+            },
+        ]
+    )
+
+    # remove the repos directory
+    for save_repo_format in ["tar", "tar.gz", "zip", "files"]:
+        repos_dir = "~/.objaverse-tests/github/repos"
+        shutil.rmtree(os.path.expanduser(repos_dir), ignore_errors=True)
+
+        out = download_github_objects(
+            objects=objects,
+            processes=1,
+            download_dir="~/.objaverse-tests",
+            save_repo_format=save_repo_format,  # type: ignore
+        )
+        assert len(out) == 3
+
+        out = download_github_objects(
+            objects=objects,
+            processes=1,
+            download_dir="~/.objaverse-tests",
+            save_repo_format=save_repo_format,  # type: ignore
+        )
+        assert len(out) == 0