Add setuptools notes

ideoforms · Dec 4, 2023 · c6d4453 · c6d4453
1 parent 3311941
commit c6d4453
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -13,6 +13,8 @@ jobs:
         sudo apt-get update -y
         sudo apt-get install libasound2-dev libsoundio-dev libsndfile1-dev fftw3-dev -y
         sudo apt-get install python3 python3-setuptools python3-pip 
+        # Requires setuptools >= 62.1 for `python setup.py test`, as earlier versions
+        # used a different build path to the .so file as located in tests/__init__.py
         sudo pip3 install -U pytest numpy scipy setuptools>=62.1.0
     - name: Configure
       run: mkdir build && cd build && cmake ..

diff --git a/tests/__init__.py b/tests/__init__.py
@@ -28,6 +28,7 @@
 def distutils_dir_name(dir_name):
     """
     Returns the name of a distutils build directory
+    Requires setuptools >= 62.1.0
     https://stackoverflow.com/a/14369968/1819404
     """
     f = "{dirname}.{platform}-{cache_tag}"