spaceforge 1.1.3__py3-none-any.whl → 1.1.4__py3-none-any.whl

spaceforge/README.md

@@ -13,7 +13,7 @@ Spaceforge provides a simple, declarative way to create Spacelift plugins by inh
 - **SpaceforgePlugin** (`plugin.py`) - Base class with hook methods and utilities
 - **PluginRunner** (`runner.py`) - Executes hook methods, loads parameters from environment
 - **PluginGenerator** (`generator.py`) - Analyzes Python plugins and generates `plugin.yaml`
-- **CLI Interface** (`__main__.py`) - Click-based CLI with `generate` and `runner` subcommands
+- **CLI Interface** (`__main__.py`) - Click-based CLI with `generate` and `run` subcommands
 - **Pydantic Dataclasses** (`cls.py`) - Type-safe data structures with validation
 
 ### Data Validation
@@ -242,10 +242,10 @@ python -m spaceforge generate my_plugin.py -o my_plugin.yaml
 export API_KEY="your-key"
 
 # Run specific hook
-python -m spaceforge runner after_plan
+python -m spaceforge run after_plan
 
 # Run with specific plugin file
-python -m spaceforge runner --plugin-file my_plugin.py before_apply
+python -m spaceforge run --plugin-file my_plugin.py before_apply
 ```
 
 ### Get Help
@@ -253,7 +253,7 @@ python -m spaceforge runner --plugin-file my_plugin.py before_apply
 ```bash
 python -m spaceforge --help
 python -m spaceforge generate --help
-python -m spaceforge runner --help
+python -m spaceforge run --help
 ```
 
 ## Generated YAML Structure
@@ -264,7 +264,7 @@ The framework automatically generates standard Spacelift plugin YAML:
 
 1. **Requirements**: If your plugin has dependencies, create a `requirements.txt` file. The generator will automatically add a `before_init` hook to install them.
 
-2. **Testing**: Use the runner command to test individual hooks during development.
+2. **Testing**: Use the `run` command to test individual hooks during development.
 
 3. **Debugging**: Set `SPACELIFT_DEBUG=true` to enable debug logging.
 

spaceforge/__main__.py

@@ -6,7 +6,7 @@ import click
 
 from spaceforge._version import get_version
 from spaceforge.generator import generate_command
-from spaceforge.runner import runner_command
+from spaceforge.runner import run_command
 
 
 @click.group()
@@ -21,7 +21,18 @@ def cli() -> None:
 
 # Add subcommands
 cli.add_command(generate_command)
-cli.add_command(runner_command)
+cli.add_command(run_command)
+
+# KLUDGE: Add a hidden "runner" alias to the "run" command for backward compatibility.
+# It could be removed in the next major version.
+runner_alias = click.Command(
+    callback=run_command.callback,
+    help=run_command.help,
+    hidden=True,
+    name="runner",
+    params=run_command.params,
+)
+cli.add_command(runner_alias)
 
 
 def main() -> None:

spaceforge/_version_scm.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.1.3'
-__version_tuple__ = version_tuple = (1, 1, 3)
+__version__ = version = '1.1.4'
+__version_tuple__ = version_tuple = (1, 1, 4)
 
 __commit_id__ = commit_id = None

spaceforge/runner.py

@@ -84,7 +84,7 @@ class PluginRunner:
 import click
 
 
-@click.command(name="runner")
+@click.command(name="run")
 @click.argument("hook_name")
 @click.option(
     "--plugin-file",
@@ -92,7 +92,7 @@ import click
     type=click.Path(exists=True, dir_okay=False, readable=True),
     help="Path to the plugin Python file (default: plugin.py)",
 )
-def runner_command(hook_name: str, plugin_file: str) -> None:
+def run_command(hook_name: str, plugin_file: str) -> None:
     """Run a specific hook method from a plugin.
 
     HOOK_NAME: Name of the hook method to execute (e.g., after_plan, before_apply)

spaceforge/templates/ensure_spaceforge_and_run.sh.j2

@@ -21,4 +21,4 @@ fi
 export PATH="/mnt/workspace/plugins/plugin_binaries:$PATH"
 {% endif %}
 cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
-spaceforge runner --plugin-file {{plugin_file}} {{phase}}
+spaceforge run --plugin-file {{plugin_file}} {{phase}}

spaceforge/test_generator.py

@@ -88,7 +88,6 @@ class PluginExample(SpaceforgePlugin):
 
 
 class TestPluginGenerator:
-
     def setup_method(self) -> None:
         """Setup test fixtures."""
         self.temp_dir = tempfile.mkdtemp()
@@ -534,7 +533,7 @@ class NotAPlugin:
                 after_plan_script = mf
                 break
         assert after_plan_script is not None
-        assert "spaceforge runner" in after_plan_script.content
+        assert "spaceforge run" in after_plan_script.content
         assert "after_plan" in after_plan_script.content
 
     def test_generate_manifest(self) -> None:

spaceforge/test_runner.py

@@ -6,7 +6,7 @@ from unittest.mock import Mock, patch
 import pytest
 
 from spaceforge.plugin import SpaceforgePlugin
-from spaceforge.runner import PluginRunner, runner_command
+from spaceforge.runner import PluginRunner, run_command
 
 
 class PluginForTesting(SpaceforgePlugin):
@@ -41,7 +41,6 @@ class PluginForTesting(SpaceforgePlugin):
 
 
 class TestPluginRunner:
-
     def setup_method(self) -> None:
         """Setup test fixtures."""
         self.temp_dir = tempfile.mkdtemp()
@@ -293,7 +292,7 @@ class ClickTestPlugin(SpaceforgePlugin):
 
         shutil.rmtree(self.temp_dir, ignore_errors=True)
 
-    def test_runner_command(self) -> None:
+    def test_run_command(self) -> None:
         """Test the Click runner command."""
         from click.testing import CliRunner
 
@@ -305,7 +304,7 @@ class ClickTestPlugin(SpaceforgePlugin):
 
             # Test the command using Click's test runner
             result = cli_runner.invoke(
-                runner_command, ["after_plan", "--plugin-file", self.test_plugin_path]
+                run_command, ["after_plan", "--plugin-file", self.test_plugin_path]
             )
 
             assert result.exit_code == 0
@@ -316,7 +315,7 @@ class ClickTestPlugin(SpaceforgePlugin):
             # Verify run_hook was called with correct hook name
             mock_runner.run_hook.assert_called_once_with("after_plan")
 
-    def test_runner_command_default_plugin_file(self) -> None:
+    def test_run_command_default_plugin_file(self) -> None:
         """Test runner command with default plugin file."""
         from click.testing import CliRunner
 
@@ -328,7 +327,7 @@ class ClickTestPlugin(SpaceforgePlugin):
 
             # Test with explicit plugin file path
             result = cli_runner.invoke(
-                runner_command, ["before_apply", "--plugin-file", self.test_plugin_path]
+                run_command, ["before_apply", "--plugin-file", self.test_plugin_path]
             )
 
             assert result.exit_code == 0

spaceforge/test_runner_cli.py

@@ -3,7 +3,7 @@
 import os
 from unittest.mock import Mock, patch
 
-from spaceforge.runner import runner_command
+from spaceforge.runner import run_command
 
 
 class TestRunnerClickCommand:
@@ -34,7 +34,7 @@ class ClickTestPlugin(SpaceforgePlugin):
             mock_runner_class.return_value = mock_runner
 
             result = cli_runner.invoke(
-                runner_command, ["after_plan", "--plugin-file", click_plugin_path]
+                run_command, ["after_plan", "--plugin-file", click_plugin_path]
             )
 
         # Assert
@@ -60,7 +60,7 @@ class ClickTestPlugin(SpaceforgePlugin):
             mock_runner_class.return_value = mock_runner
 
             result = cli_runner.invoke(
-                runner_command, ["before_apply", "--plugin-file", custom_plugin_path]
+                run_command, ["before_apply", "--plugin-file", custom_plugin_path]
             )
 
         # Assert

{spaceforge-1.1.3.dist-info → spaceforge-1.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 1.1.3
+Version: 1.1.4
 Summary: A Python framework for building Spacelift plugins
 Home-page: https://github.com/spacelift-io/plugins
 Author: Spacelift
@@ -60,15 +60,15 @@ pip install spaceforge
 
 ### 1. Create Your Plugin
 
-Create a Python file (e.g., `my_plugin.py`) and inherit from `SpaceforgePlugin`:
+Create a Python file (e.g., `plugin.py`) and inherit from `SpaceforgePlugin`:
 
 ```python
-from spaceforge import SpaceforgePlugin, Parameter, Variable, Context, Binary, Policy, Webhook, MountedFile
+from spaceforge import SpaceforgePlugin, Parameter, Variable, Context
 import os
 
 class MyPlugin(SpaceforgePlugin):
     # Plugin metadata
-    __plugin_name__ = "my-awesome-plugin"
+    __plugin_name__ = "my-plugin"
     __version__ = "1.0.0"
     __author__ = "Your Name"
     __labels__ = ["security", "monitoring"]  # Optional labels for categorization
@@ -127,7 +127,7 @@ class MyPlugin(SpaceforgePlugin):
 Generate the Spacelift plugin YAML manifest:
 
 ```bash
-spaceforge generate my_plugin.py
+spaceforge generate plugin.py
 ```
 
 This creates `plugin.yaml` that you can upload to Spacelift.
@@ -142,7 +142,7 @@ export API_KEY="your-api-key"
 export ENVIRONMENT="staging"
 
 # Test the after_plan hook
-spaceforge runner after_plan
+spaceforge run after_plan
 ```
 
 ## Available Hooks
@@ -527,13 +527,13 @@ export API_KEY="test-key"
 export TIMEOUT="60"
 
 # Test specific hook
-spaceforge runner after_plan
+spaceforge run after_plan
 
 # Test with specific plugin file
-spaceforge runner --plugin-file my_plugin.py before_apply
+spaceforge run --plugin-file my_plugin.py before_apply
 
 # Get help
-spaceforge runner --help
+spaceforge run --help
 ```
 
 ## Plugin Development Tips
@@ -577,7 +577,7 @@ def after_plan(self):
 ### 4. Testing and Debugging
 
 - Set `SPACELIFT_DEBUG=true` to enable debug logging
-- Use the runner command to test hooks during development
+- Use the `run` command to test hooks during development
 - Test with different parameter combinations
 - Validate your generated YAML before uploading to Spacelift
 
@@ -718,7 +718,7 @@ spaceforge generate security_scanner.py
 # Test locally
 export API_TOKEN="your-token"
 export SEVERITY_THRESHOLD="high"
-spaceforge runner after_plan
+spaceforge run after_plan
 ```
 
 ## Speeding up plugin execution
@@ -734,8 +734,8 @@ There are a few things you can do to speed up plugin execution.
 
 1. **Install spaceforge:** `pip install spaceforge`
 2. **Create your plugin:** Start with the quick start example
-3. **Test locally:** Use the runner command to test your hooks
-4. **Generate manifest:** Use the generate command to create plugin.yaml
+3. **Test locally:** Use the `run` command to test your hooks
+4. **Generate manifest:** Use the `generate` command to create plugin.yaml
 5. **Upload to Spacelift:** Add your plugin manifest to your Spacelift account
 
 For more advanced examples, see the [plugins](plugins/) directory in this repository.

{spaceforge-1.1.3.dist-info → spaceforge-1.1.4.dist-info}/RECORD

@@ -1,16 +1,16 @@
-spaceforge/README.md,sha256=8o1Nuyasb4OxX3E7ZycyducOrR4J19bZcHrLvFeoFNg,7730
+spaceforge/README.md,sha256=gDyCQN0EW4xp8Skvs6J0qHpO9CjVTnRfSnhduAIFQs4,7717
 spaceforge/__init__.py,sha256=TU-vvm15dK1ucixNW0V42eTT72x3_hmKSyxP4MC1Occ,589
-spaceforge/__main__.py,sha256=c3nAw4WBnHXIcfMlRV6Ja7r87pEhSeK-SAqiSYIasIY,643
+spaceforge/__main__.py,sha256=UKbeCuEFgoNlEOX44-kYUAQuUdySdkAKsvbjXEyLeWI,965
 spaceforge/_version.py,sha256=RP_LfUd4ODnrfwn9nam8wB6bR3lM4VwmoRxK08Tkiiw,2155
-spaceforge/_version_scm.py,sha256=87v_vDfphCRXvmiytdhoHtQyIWrsYHjMp8634JpDrR4,704
+spaceforge/_version_scm.py,sha256=u-IJdVvNgkPmB4EypXx7iHPUTbdrT6j_v7FWXSVMszE,704
 spaceforge/cls.py,sha256=oYW5t5_xs9ZM6Ne_b4trxCPxLHQrqbqgUeibeM8O4PU,6329
 spaceforge/conftest.py,sha256=U-xCavCsgRAQXqflIIOMeq9pcGbeqRviUNkEXgZol8g,2141
 spaceforge/generator.py,sha256=hCxtbOKmrGd7HCCz7HMaiK566kIre5MNxcJEx2TVURM,18430
 spaceforge/plugin.py,sha256=Ytm2B7nnJNH231V4gUFY1pBmwVNTpIg3YviUL_Bnf24,14963
-spaceforge/runner.py,sha256=EUZ98gmOiJ766zOSk7YcTTrLCtHfst1xf3iE2Xu7Tao,3172
+spaceforge/runner.py,sha256=NNddgK_OsnQWx2YFcyTpAOWfFLBDUphufBVfXYEzfzM,3166
 spaceforge/schema.json,sha256=89IROLVlCj8txGMiLt4Bbuo_2muSxKoZCyaXQ2vuA9c,10869
 spaceforge/test_cls.py,sha256=nXAgbnFnGdFxrtA7vNXiePjNUASuoYW-lEuQGx9WMGs,468
-spaceforge/test_generator.py,sha256=Nst3YVu_iZbFopH6ajjxCfqYrZvybteGbwMfZzjBFnI,32615
+spaceforge/test_generator.py,sha256=k2jPEqNEJ9jYiY3xGf59Bo3VxTK6s_jEe3hZ0D8i79U,32611
 spaceforge/test_generator_binaries.py,sha256=X_7pPLGE45eQt-Kv9_ku__LsyLgOvViHc_BvVpSCMp0,7263
 spaceforge/test_generator_core.py,sha256=gOqRx0rnME-srGMHun4KidXMN-iaqfKKTyoQ0Tw6b9Q,6253
 spaceforge/test_generator_hooks.py,sha256=2lJs8dYlFb7QehWcYF0O4qg38s5UudEpzJyBi1XiS3k,2542
@@ -19,15 +19,15 @@ spaceforge/test_plugin.py,sha256=rZ4Uv_0lIR0qb1GFHkiosGO3WHTWhO7epz8INDxV8Q0,130
 spaceforge/test_plugin_file_operations.py,sha256=B0qvIo5EcfKMiHLhBv-hAnpSonn83ojcmJHXasydojA,3782
 spaceforge/test_plugin_hooks.py,sha256=ugaVdzH1-heRJSJN0lu8zoqLcLPC3tg_PzUX98qu9Sw,1038
 spaceforge/test_plugin_inheritance.py,sha256=WHfvU5s-2GtfcI9-1bHXH7bacr77ikq68V3Z3BBQKvQ,3617
-spaceforge/test_runner.py,sha256=fDnUf6gEuf1CNMxz6zs3xXvERQsQU3z8qy9KdUc0Wo4,17739
-spaceforge/test_runner_cli.py,sha256=Sf5X0O9Wc9EhGB5L8SzvlmO7QmgQZQoClSdNYefa-lQ,2299
+spaceforge/test_runner.py,sha256=PWFiGsBSJ6QXL5OyGA_OoDIILtRaX1NDQnech15Ady0,17723
+spaceforge/test_runner_cli.py,sha256=qkklvRHETCmgKaVxPfUR_IBy7Vne5hKupAOK9igKqLA,2290
 spaceforge/test_runner_core.py,sha256=eNR9YOwJwv7LsMtNQ4WXXMPIW6RE_A7hUp4bCpzz1Rk,3941
 spaceforge/test_runner_execution.py,sha256=GJhoECdhIY2M3MWcmTrIYfkJd2P5n86zixO3FY38_CQ,5344
 spaceforge/templates/binary_install.sh.j2,sha256=I3setUsp6fCUJLkynvfZT4DCqVsoEQ42rhSmK6MJVAY,1517
-spaceforge/templates/ensure_spaceforge_and_run.sh.j2,sha256=g5BldIEve0IkZ-mCzTXfB_rFvyWqUJqymRRaaMrpp0s,550
-spaceforge-1.1.3.dist-info/licenses/LICENSE,sha256=wyljRrfnWY2ggQKkSCg3Nw2hxwPMmupopaKs9Kpgys8,1065
-spaceforge-1.1.3.dist-info/METADATA,sha256=Coa8xC2VcIG_k4mB_uPXMF_uTSzA3tK8MUCJ-AeZ9d0,21164
-spaceforge-1.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-spaceforge-1.1.3.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
-spaceforge-1.1.3.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
-spaceforge-1.1.3.dist-info/RECORD,,
+spaceforge/templates/ensure_spaceforge_and_run.sh.j2,sha256=8vq9cvFtNLjgcEr8OPblZ6bQRsOsklOnDOzygnw3We4,547
+spaceforge-1.1.4.dist-info/licenses/LICENSE,sha256=wyljRrfnWY2ggQKkSCg3Nw2hxwPMmupopaKs9Kpgys8,1065
+spaceforge-1.1.4.dist-info/METADATA,sha256=Lnb0ePCPWnJ80Ga_CDX7MC83jBTZ6zGtL-yRDguNXSA,21097
+spaceforge-1.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+spaceforge-1.1.4.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
+spaceforge-1.1.4.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
+spaceforge-1.1.4.dist-info/RECORD,,