spin 0.10__tar.gz → 0.12__tar.gz

{spin-0.10/spin.egg-info → spin-0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spin
-Version: 0.10
+Version: 0.12
 Summary: Developer tool for scientific Python libraries
 Maintainer-email: Scientific Python <spin@discuss.scientific-python.org>
 License: BSD 3-Clause License
@@ -55,7 +55,7 @@ Requires-Dist: tomli; python_version < "3.11"
 Requires-Dist: colorama; platform_system == "Windows"
 Requires-Dist: importlib_metadata>=7
 Provides-Extra: lint
-Requires-Dist: pre-commit==3.7.0; extra == "lint"
+Requires-Dist: pre-commit==3.8.0; extra == "lint"
 Provides-Extra: dev
 Requires-Dist: changelist==0.5; extra == "dev"
 
@@ -147,15 +147,15 @@ python -m spin
 Available as `spin.cmds.meson.*`.
 
 ```
-  build    🔧 Build package with Meson/ninja
-  ipython  💻 Launch IPython shell with PYTHONPATH set
-  python   🐍 Launch Python shell with PYTHONPATH set
-  shell    💻 Launch shell with PYTHONPATH set
-  test     🔧 Run pytest
-  run      🏁 Run a shell command with PYTHONPATH set
-  docs     📖 Build Sphinx documentation
-  gdb      👾 Execute a Python snippet with GDB
-  lldb     👾 Execute a Python snippet with LLDB
+build      🔧 Build package with Meson/ninja
+ipython    💻 Launch IPython shell with PYTHONPATH set
+python     🐍 Launch Python shell with PYTHONPATH set
+shell      💻 Launch shell with PYTHONPATH set
+test       🔧 Run pytest
+run        🏁 Run a shell command with PYTHONPATH set
+docs       📖 Build Sphinx documentation
+gdb        👾 Execute a Python snippet with GDB
+lldb       👾 Execute a Python snippet with LLDB
 ```
 
 ### [Build](https://pypa-build.readthedocs.io/en/stable/) (PEP 517 builder)
@@ -163,7 +163,7 @@ Available as `spin.cmds.meson.*`.
 Available as `spin.cmds.build.*`:
 
 ```
-  sdist    📦 Build a source distribution in `dist/`
+sdist      📦 Build a source distribution in `dist/`
 ```
 
 ### [pip](https://pip.pypa.io) (Package Installer for Python)
@@ -174,7 +174,15 @@ development workflow.
 Available as `spin.cmds.pip.*`:
 
 ```
-  install  💽 Build and install package using pip.
+install    💽 Build and install package using pip.
+```
+
+### Meta (commands that operate on commands)
+
+Available as `spin.cmds.meta.*`:
+
+```
+introspect 🔍 Print a command's location and source code
 ```
 
 ## 🧪 Custom commands
@@ -310,6 +318,13 @@ fc-cache -f -v
 nox -s test
 ```
 
+Other examples:
+
+```
+nox -s test -- -v
+nox -s test -- -v spin/tests/test_meson.py
+```
+
 ## History
 
 The `dev.py` tool was [proposed for SciPy](https://github.com/scipy/scipy/issues/15489) by Ralf Gommers and [implemented](https://github.com/scipy/scipy/pull/15959) by Sayantika Banik, Eduardo Naufel Schettino, and Ralf Gommers (also see [Sayantika's blog post](https://labs.quansight.org/blog/the-evolution-of-the-scipy-developer-cli)).

{spin-0.10 → spin-0.12}/README.md

@@ -86,15 +86,15 @@ python -m spin
 Available as `spin.cmds.meson.*`.
 
 ```
-  build    🔧 Build package with Meson/ninja
-  ipython  💻 Launch IPython shell with PYTHONPATH set
-  python   🐍 Launch Python shell with PYTHONPATH set
-  shell    💻 Launch shell with PYTHONPATH set
-  test     🔧 Run pytest
-  run      🏁 Run a shell command with PYTHONPATH set
-  docs     📖 Build Sphinx documentation
-  gdb      👾 Execute a Python snippet with GDB
-  lldb     👾 Execute a Python snippet with LLDB
+build      🔧 Build package with Meson/ninja
+ipython    💻 Launch IPython shell with PYTHONPATH set
+python     🐍 Launch Python shell with PYTHONPATH set
+shell      💻 Launch shell with PYTHONPATH set
+test       🔧 Run pytest
+run        🏁 Run a shell command with PYTHONPATH set
+docs       📖 Build Sphinx documentation
+gdb        👾 Execute a Python snippet with GDB
+lldb       👾 Execute a Python snippet with LLDB
 ```
 
 ### [Build](https://pypa-build.readthedocs.io/en/stable/) (PEP 517 builder)
@@ -102,7 +102,7 @@ Available as `spin.cmds.meson.*`.
 Available as `spin.cmds.build.*`:
 
 ```
-  sdist    📦 Build a source distribution in `dist/`
+sdist      📦 Build a source distribution in `dist/`
 ```
 
 ### [pip](https://pip.pypa.io) (Package Installer for Python)
@@ -113,7 +113,15 @@ development workflow.
 Available as `spin.cmds.pip.*`:
 
 ```
-  install  💽 Build and install package using pip.
+install    💽 Build and install package using pip.
+```
+
+### Meta (commands that operate on commands)
+
+Available as `spin.cmds.meta.*`:
+
+```
+introspect 🔍 Print a command's location and source code
 ```
 
 ## 🧪 Custom commands
@@ -249,6 +257,13 @@ fc-cache -f -v
 nox -s test
 ```
 
+Other examples:
+
+```
+nox -s test -- -v
+nox -s test -- -v spin/tests/test_meson.py
+```
+
 ## History
 
 The `dev.py` tool was [proposed for SciPy](https://github.com/scipy/scipy/issues/15489) by Ralf Gommers and [implemented](https://github.com/scipy/scipy/pull/15959) by Sayantika Banik, Eduardo Naufel Schettino, and Ralf Gommers (also see [Sayantika's blog post](https://labs.quansight.org/blog/the-evolution-of-the-scipy-developer-cli)).

{spin-0.10 → spin-0.12}/pyproject.toml

@@ -34,12 +34,15 @@ dynamic = ['version']
 spin = "spin.__main__:main"
 
 [project.optional-dependencies]
-lint = ["pre-commit == 3.7.0"]
+lint = ["pre-commit == 3.8.0"]
 dev = ["changelist == 0.5"]
 
 [project.urls]
 homepage = "https://github.com/scientific-python/spin"
 
+[tool.changelist]
+ignored_user_logins = ["dependabot[bot]", "pre-commit-ci[bot]", "web-flow"]
+
 [tool.setuptools.dynamic.version]
 attr = 'spin.__version__'
 
@@ -47,13 +50,13 @@ attr = 'spin.__version__'
 include = ["spin*"]
 
 [tool.pytest.ini_options]
+minversion = "8.0"
+addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
+xfail_strict = true
 filterwarnings = [
   "ignore:cannot collect 'test' because it is not a function:",
 ]
-
-[tool.ruff]
-line-length = 88
-target-version = "py38"
+log_cli_level = "info"
 
 [tool.ruff.lint]
 select = [
@@ -63,6 +66,11 @@ select = [
     "W",
     "B",
     "I",
+    "C4",
+    "ISC",
+    "PGH",
     "UP",
+    "FURB",
+    "PYI",
 ]
 ignore = ["B006", "C901", "E501", "E722"]

{spin-0.10 → spin-0.12}/spin/__init__.py

@@ -6,7 +6,7 @@ For usage information see `python -m spin`.
 Read more at https://github.com/scientific-python/spin
 """
 
-__version__ = "0.10"
+__version__ = "0.12"
 
 from .cmds import util
 

{spin-0.10 → spin-0.12}/spin/__main__.py

@@ -2,9 +2,11 @@ import collections
 import importlib
 import importlib.util
 import os
+import pathlib
 import sys
 import textwrap
 import traceback
+from typing import Union
 
 import click
 
@@ -19,8 +21,26 @@ if sys.version_info >= (3, 11):
 else:
     import tomli as tomllib
 
+
 click.Context.formatter_class = ColorHelpFormatter
 
+config_filenames = (
+    ".spin.toml",
+    "spin.toml",
+    "pyproject.toml",
+)
+
+
+def _detect_config_dir(path: pathlib.Path) -> Union[pathlib.Path, None]:
+    path = path.resolve()
+    files = os.listdir(path)
+    if any(f in files for f in config_filenames):
+        return path
+    elif path.parent != path:
+        return _detect_config_dir(path.parent)
+    else:
+        return None
+
 
 def main():
     # Alias `spin help` to `spin --help`
@@ -38,15 +58,25 @@ def main():
 
     toml_config = collections.ChainMap()
     toml_config.maps.extend(
-        DotDict(cfg)
-        for filename in (
-            ".spin.toml",
-            "spin.toml",
-            "pyproject.toml",
-        )
-        if (cfg := load_toml(filename))
+        DotDict(cfg) for filename in config_filenames if (cfg := load_toml(filename))
     )
 
+    if not toml_config:
+        click.secho(
+            f"Could not load configuration from one of: {', '.join(config_filenames)}",
+            file=sys.stderr,
+            fg="red",
+        )
+        config_dir = _detect_config_dir(pathlib.Path("."))
+        if config_dir:
+            print()
+            print(
+                "Are you running `spin` from the correct directory? Perhaps you'd like to\n"
+            )
+            click.secho(f" $ cd {os.path.relpath(config_dir, '.')}\n")
+            print("and try again.")
+        sys.exit(1)
+
     # Basic configuration validation
     version_query = len(sys.argv) == 2 and (sys.argv[1] == "--version")
 
@@ -55,15 +85,18 @@ def main():
         if "tool.spin" in toml_config:
             spin_config = toml_config["tool.spin"]
             if "tool.spin.commands" not in toml_config:
-                print(
-                    "Error: configuration is missing section [tool.spin.commands]\n",
+                click.secho(
+                    "Error: configuration is missing section [tool.spin.commands]\n"
+                    "See https://github.com/scientific-python/spin/blob/main/README.md\n",
                     file=sys.stderr,
+                    fg="red",
                 )
         else:
-            print(
+            click.secho(
                 "Error: need valid configuration in [.spin.toml], [spin.toml], or [pyproject.toml]\n"
                 "See https://github.com/scientific-python/spin/blob/main/README.md\n",
                 file=sys.stderr,
+                fg="red",
             )
 
     proj_name = (
@@ -132,10 +165,14 @@ def main():
 
                 try:
                     cmd_func = getattr(mod, func)
+                    cmd_func.module = mod  # metadata for use by `introspect` command
                 except AttributeError:
                     print(f"!! Could not load command `{func}` from file `{path}`.\n")
                     continue
 
+                # Save command definition for use in `introspect`
+                cmd_func.spec = cmd
+
                 default_kwargs = cmd_default_kwargs.get(cmd)
                 import functools
 

spin-0.12/spin/cmds/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["meson"]
+
+from . import meson

spin-0.12/spin/cmds/build.py

@@ -0,0 +1,15 @@
+import click
+
+from .util import run
+
+
+@click.command()
+@click.argument("pyproject-build-args", metavar="", nargs=-1)
+def sdist(pyproject_build_args):
+    """📦 Build a source distribution in `dist/`
+
+    Extra arguments are passed to `pyproject-build`, e.g.
+
+      spin sdist -- -x -n
+    """
+    run(["pyproject-build", ".", "--sdist"] + list(pyproject_build_args))