Rename devpy to spin (neurodata#54)

Signed-off-by: Adam Li <[email protected]>
Co-authored-by: Adam Li <[email protected]>

Author: jarrodmillman

.circleci/config.yml

@@ -89,14 +89,14 @@ jobs:
           name: setup Python venv
           command: |
             pip install -r build_requirements.txt
-            pip install git+https://github.com/scientific-python/[email protected]
+            pip install spin
             pip install -r doc_requirements.txt
             # extra benchmark deps
             pip install pytest
       - run:
           name: build scikit-tree
           command: |
-            python dev.py build -j2
+            python spin build -j2
       - save_cache:
           key: deps_ccache-{{ .Branch }}
           paths:

.github/workflows/main.yml

@@ -68,7 +68,7 @@ jobs:
       - name: Install Python packages
         run: |
           python -m pip install -r build_requirements.txt
-          python -m pip install git+https://github.com/scientific-python/[email protected]
+          python -m pip install spin
           python -m pip install -r test_requirements.txt
 
       - name: Prepare compiler cache
@@ -98,7 +98,7 @@ jobs:
 
       - name: Setup build and install scikit-tree
         run: |
-          python dev.py build -j 2
+          python spin build -j 2
 
       - name: Ccache performance
         shell: bash -l {0}
@@ -111,10 +111,10 @@ jobs:
 
       - name: Run unit tests and coverage
         run: |
-          ./dev.py --help
-          ./dev.py coverage --help
-          ./dev.py test --help
-          python dev.py coverage
+          ./spin --help
+          ./spin coverage --help
+          ./spin test --help
+          python spin coverage
           cp $PWD/build-install/usr/lib/python${{matrix.python-version}}/site-packages/coverage.xml ./coverage.xml
 
       - name: debug
@@ -128,7 +128,7 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-22.04' && matrix.python-version == '3.10'}}
         uses: codecov/codecov-action@v3
         with:
-          # python dev.py goes into the INSTALLED path in order to run pytest
+          # python spin goes into the INSTALLED path in order to run pytest
           files: ./coverage.xml
           fail_ci_if_error: true
           verbose: true
@@ -162,7 +162,7 @@ jobs:
       - name: pip-packages
         run: |
           pip install -r build_requirements.txt
-          pip install git+https://github.com/scientific-python/[email protected]
+          pip install spin
       - name: openblas-libs
         run: |
           # Download and install pre-built OpenBLAS library
@@ -185,7 +185,7 @@ jobs:
           meson install
       # - name: build
       #   run: |
-      #     python dev.py build -j 2
+      #     python spin build -j 2
       #     # following steps are required because the build step does not put
       #     # the *.pyd files in build-install! Furthermore the --win-cp-openblas
       #     # option does not seem to copy libopenblas*.dll, so manually copy it.

.devpy/cmds.py renamed to .spin/cmds.py

@@ -3,8 +3,8 @@
 import sys
 
 import click
-from devpy import util
-from devpy.cmds import meson
+from spin import util
+from spin.cmds import meson
 
 
 @click.command()
@@ -20,7 +20,7 @@ def docs(build_dir, clean=False):
 
     site_path = meson._get_site_packages()
     if site_path is None:
-        print("No built scikit-tree found; run `./dev.py build` first.")
+        print("No built scikit-tree found; run `./spin build` first.")
         sys.exit(1)
 
     util.run(["pip", "install", "-q", "-r", "doc_requirements.txt"])
@@ -37,7 +37,7 @@ def coverage():
         [
             "python",
             "-m",
-            "devpy",
+            "spin",
             "test",
             "--",
             "-o",

README.md

@@ -49,32 +49,30 @@ Make sure you have the necessary packages installed
     # make sure we have our fork of scikit-learn
     pip install scikit-learn@git+https://[email protected]/neurodata/scikit-learn.git@fork
 
-    pip install spin
-
-After you have installed the relevant dependencies and also installed the scikit-learn fork, you can build the package locally. We use the ``dev.py`` CLI to abstract away build details:
+We use the ``spin`` CLI to abstract away build details:
 
     # run the build using Meson/Ninja
-    ./dev.py build
-
+    ./spin build
+    
     # you can run the following command to see what other options there are
-    ./dev.py --help
-    ./dev.py build --help
+    ./spin --help
+    ./spin build --help
 
     # For example, you might want to start from a clean build
-    ./dev.py build --clean
+    ./spin build --clean
 
     # or build in parallel for faster builds
-    ./dev.py build -j 2
+    ./spin build -j 2
 
     # you will need to double check the build-install has the proper path 
     # this might be different from machine to machine
     export PYTHONPATH=${PWD}/build-install/usr/lib/python3.9/site-packages
 
     # run specific unit tests
-    ./dev.py test -- sktree/tree/tests/test_tree.py
+    ./spin test -- sktree/tree/tests/test_tree.py
 
     # you can bring up the CLI menu
-    ./dev.py --help
+    ./spin --help
 
 You can also do the same thing using Meson/Ninja itself. Run the following to build the local files:
 

docs/install.rst

@@ -45,13 +45,13 @@ Then run installation of build packages
 .. code-block:: bash
 
     pip install -r build_requirements.txt
-    pip install git+https://github.com/scientific-python/devpy
+    pip install spin
     
-    # use dev.py CLI to run Meson build locally
-    ./dev.py build -j 2
+    # use spin CLI to run Meson build locally
+    ./spin build -j 2
 
     # you can now run tests
-    ./dev.py test 
+    ./spin test 
 
 via pip, you will be able to install in editable mode (pending Meson-Python support).
 

pyproject.toml

@@ -203,17 +203,17 @@ precision = 2
 exclude_dirs = ["sktree/tests", "sktree/tree/tests", 'sktree/_build_utils/*']
 skips = ['B404', 'B603']
 
-[tool.devpy]
+[tool.spin]
 package = 'sktree'
 
-[tool.devpy.commands]
-Build = ["devpy.cmds.meson.build", "devpy.cmds.meson.test"]
+[tool.spin.commands]
+Build = ["spin.cmds.meson.build", "spin.cmds.meson.test"]
 Environments = [
-    'devpy.cmds.meson.shell',
-    'devpy.cmds.meson.ipython',
-    'devpy.cmds.meson.python',
+    'spin.cmds.meson.shell',
+    'spin.cmds.meson.ipython',
+    'spin.cmds.meson.python',
 ]
-Documentation = ['.devpy/cmds.py:docs']
+Documentation = ['.spin/cmds.py:docs']
 Metrics = [
-    '.devpy/cmds.py:coverage',
+    '.spin/cmds.py:coverage',
 ]

dev.py renamed to spin

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Example stub for running `python -m dev.py`
+# Example stub for running `python -m spin`
 #
 # Copy this into your project root.
 
@@ -10,9 +10,9 @@
 
 sys.path.remove(os.path.abspath(os.path.dirname(sys.argv[0])))
 try:
-    runpy.run_module("devpy", run_name="__main__")
+    runpy.run_module("spin", run_name="__main__")
 except ImportError:
-    print("Cannot import devpy; please install it using")
+    print("Cannot import spin; please install it using")
     print()
     print("  pip install spin")
     print()