spaceforge 0.1.0.dev0__py3-none-any.whl

spaceforge/schema.json

@@ -0,0 +1,371 @@
+{
+  "$defs": {
+    "Context": {
+      "description": "A class to represent a context for a plugin.\n\nAttributes:\n    name_prefix (str): The name of the context, will be appended with a unique ID.\n    description (str): A description of the context.\n    labels (dict): Labels associated with the context.\n    env (list): List of variables associated with the context.\n    hooks (dict): Hooks associated with the context.",
+      "properties": {
+        "name_prefix": {
+          "title": "Name Prefix",
+          "type": "string"
+        },
+        "description": {
+          "title": "Description",
+          "type": "string"
+        },
+        "env": {
+          "anyOf": [
+            {
+              "items": {
+                "$ref": "#/$defs/Variable"
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Env"
+        },
+        "mounted_files": {
+          "anyOf": [
+            {
+              "items": {
+                "$ref": "#/$defs/MountedFile"
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Mounted Files"
+        },
+        "hooks": {
+          "anyOf": [
+            {
+              "additionalProperties": {
+                "items": {
+                  "type": "string"
+                },
+                "type": "array"
+              },
+              "propertyNames": {
+                "enum": [
+                  "before_init",
+                  "after_init",
+                  "before_plan",
+                  "after_plan",
+                  "before_apply",
+                  "after_apply",
+                  "before_perform",
+                  "after_perform",
+                  "before_destroy",
+                  "after_destroy",
+                  "after_run"
+                ]
+              },
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Hooks"
+        },
+        "labels": {
+          "anyOf": [
+            {
+              "additionalProperties": {
+                "type": "string"
+              },
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Labels"
+        }
+      },
+      "required": [
+        "name_prefix",
+        "description"
+      ],
+      "title": "Context",
+      "type": "object"
+    },
+    "MountedFile": {
+      "description": "A class to represent a mounted file.\n\nAttributes:\n    path (str): The path of the mounted file.\n    content (str): The content of the mounted file.\n    sensitive (bool): Whether the content of the file is sensitive.",
+      "properties": {
+        "path": {
+          "title": "Path",
+          "type": "string"
+        },
+        "content": {
+          "title": "Content",
+          "type": "string"
+        },
+        "sensitive": {
+          "default": false,
+          "title": "Sensitive",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "path",
+        "content"
+      ],
+      "title": "MountedFile",
+      "type": "object"
+    },
+    "Parameter": {
+      "description": "A class to represent a parameter with a name and value.\n\nAttributes:\n    name (str): The name of the parameter.\n    description (str): A description of the parameter.\n    sensitive (bool): Whether the parameter contains sensitive information.\n    required (bool): Whether the parameter is required.\n    default (Optional[str]): The default value of the parameter, if any. (required if sensitive is False)",
+      "properties": {
+        "name": {
+          "title": "Name",
+          "type": "string"
+        },
+        "description": {
+          "title": "Description",
+          "type": "string"
+        },
+        "sensitive": {
+          "default": false,
+          "title": "Sensitive",
+          "type": "boolean"
+        },
+        "required": {
+          "default": false,
+          "title": "Required",
+          "type": "boolean"
+        },
+        "default": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Default"
+        }
+      },
+      "required": [
+        "name",
+        "description"
+      ],
+      "title": "Parameter",
+      "type": "object"
+    },
+    "Policy": {
+      "description": "A class to represent a policy configuration.\n\nAttributes:\n    name_prefix (str): The name of the policy, will be appended with a unique ID.\n    type (str): The type of the policy (e.g., \"terraform\", \"kubernetes\").\n    body (str): The body of the policy, typically a configuration or script.\n    labels (Optional[dict[str, str]]): Labels associated with the policy.",
+      "properties": {
+        "name_prefix": {
+          "title": "Name Prefix",
+          "type": "string"
+        },
+        "type": {
+          "title": "Type",
+          "type": "string"
+        },
+        "body": {
+          "title": "Body",
+          "type": "string"
+        },
+        "labels": {
+          "anyOf": [
+            {
+              "additionalProperties": {
+                "type": "string"
+              },
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Labels"
+        }
+      },
+      "required": [
+        "name_prefix",
+        "type",
+        "body"
+      ],
+      "title": "Policy",
+      "type": "object"
+    },
+    "Variable": {
+      "description": "A class to represent an environment variable.\n\nAttributes:\n    key (str): The key of the environment variable.\n    value (Optional[str]): The value of the environment variable, if set.\n    value_from_parameter (Optional[str]): The name of the plugin variable to use as the value.\n    sensitive (bool): Whether the environment variable is sensitive.",
+      "properties": {
+        "key": {
+          "title": "Key",
+          "type": "string"
+        },
+        "value": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Value"
+        },
+        "value_from_parameter": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Value From Parameter"
+        },
+        "sensitive": {
+          "default": false,
+          "title": "Sensitive",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "key"
+      ],
+      "title": "Variable",
+      "type": "object"
+    },
+    "Webhook": {
+      "description": "A class to represent a webhook configuration.\n\nAttributes:\n    name_prefix (str): The name of the webhook, will be appended with a unique ID.\n    endpoint (str): The URL endpoint for the webhook.\n    labels (Optional[dict]): Labels associated with the webhook.\n    secrets (Optional[list[Variable]]): List of secrets associated with the webhook.",
+      "properties": {
+        "name_prefix": {
+          "title": "Name Prefix",
+          "type": "string"
+        },
+        "endpoint": {
+          "title": "Endpoint",
+          "type": "string"
+        },
+        "labels": {
+          "anyOf": [
+            {
+              "additionalProperties": {
+                "type": "string"
+              },
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Labels"
+        },
+        "secrets": {
+          "anyOf": [
+            {
+              "items": {
+                "$ref": "#/$defs/Variable"
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Secrets"
+        }
+      },
+      "required": [
+        "name_prefix",
+        "endpoint"
+      ],
+      "title": "Webhook",
+      "type": "object"
+    }
+  },
+  "description": "A class to represent the manifest of a Spacelift plugin.\n\nAttributes:\n    name_prefix (str): The name of the plugin, will be appended with a unique ID.\n    description (str): A description of the plugin.\n    author (str): The author of the plugin.\n    parameters (list[Parameter]): List of parameters for the plugin.\n    contexts (list[Context]): List of contexts for the plugin.\n    webhooks (list[Webhook]): List of webhooks for the plugin.\n    policies (list[Policy]): List of policies for the plugin.",
+  "properties": {
+    "name_prefix": {
+      "title": "Name Prefix",
+      "type": "string"
+    },
+    "version": {
+      "title": "Version",
+      "type": "string"
+    },
+    "description": {
+      "title": "Description",
+      "type": "string"
+    },
+    "author": {
+      "title": "Author",
+      "type": "string"
+    },
+    "parameters": {
+      "anyOf": [
+        {
+          "items": {
+            "$ref": "#/$defs/Parameter"
+          },
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Parameters"
+    },
+    "contexts": {
+      "anyOf": [
+        {
+          "items": {
+            "$ref": "#/$defs/Context"
+          },
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Contexts"
+    },
+    "webhooks": {
+      "anyOf": [
+        {
+          "items": {
+            "$ref": "#/$defs/Webhook"
+          },
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Webhooks"
+    },
+    "policies": {
+      "anyOf": [
+        {
+          "items": {
+            "$ref": "#/$defs/Policy"
+          },
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Policies"
+    }
+  },
+  "required": [
+    "name_prefix",
+    "version",
+    "description",
+    "author"
+  ],
+  "title": "PluginManifest",
+  "type": "object"
+}

spaceforge-0.1.0.dev0.dist-info/METADATA

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: spaceforge
+Version: 0.1.0.dev0
+Summary: A Python framework for building Spacelift plugins
+Home-page: https://github.com/spacelift-io/plugins
+Author: Spacelift
+Author-email: Spacelift <support@spacelift.io>
+Maintainer-email: Spacelift <support@spacelift.io>
+License: MIT
+Project-URL: Homepage, https://github.com/spacelift-io/plugins
+Project-URL: Documentation, https://github.com/spacelift-io/plugins#readme
+Project-URL: Repository, https://github.com/spacelift-io/plugins
+Project-URL: Bug Reports, https://github.com/spacelift-io/plugins/issues
+Keywords: spacelift,plugin,framework,infrastructure,devops,spaceforge
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: pydantic>=2.11.7
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Requires-Dist: setuptools-scm[toml]>=6.2; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Spacelift Plugins
+
+A monorepo for Spacelift plugins built with the **spaceforge** framework.
+
+## Overview
+
+This repository contains:
+- **spaceforge/** - The core Python framework for building Spacelift plugins
+- **plugins/wiz/** - Wiz security scanning plugin  
+- Plugin management and generation tools
+
+## Quick Start
+
+### Installation
+
+```bash
+# Install the spaceforge framework
+pip install -e .
+```
+
+### Creating a Plugin
+
+1. Create a new directory for your plugin
+2. Implement your plugin by inheriting from `SpacepyPlugin`:
+
+```python
+from spaceforge import SpaceforgePlugin, Parameter, Variable, Context
+
+class MyPlugin(SpaceforgePlugin):
+    __plugin_name__ = "my-plugin"
+    __version__ = "1.0.0" 
+    __author__ = "Your Name"
+    
+    # Define parameters using pydantic dataclasses
+    __parameters__ = [
+        Parameter(
+            name="api_key",
+            description="API key for authentication",
+            required=True,
+            sensitive=True
+        )
+    ]
+    
+    # Define contexts using pydantic dataclasses
+    __contexts__ = [
+        Context(
+            name="main",
+            description="Main plugin context",
+            env=[
+                Variable(
+                    key="API_KEY",
+                    value_from_parameter="api_key",
+                    sensitive=True
+                )
+            ]
+        )
+    ]
+    
+    def after_plan(self):
+        self.logger.info("Running after plan hook")
+```
+
+3. Generate the plugin YAML:
+
+```bash
+python -m spaceforge generate my_plugin.py
+```
+
+### Testing Plugins
+
+```bash
+# Set plugin parameters
+export SPACEFORGE_PARAM_NAME="value"
+
+# Test specific hooks
+python -m spaceforge runner after_plan
+```
+
+## Architecture
+
+The spaceforge framework uses a hook-based architecture where plugins:
+- Inherit from `SpaceforgePlugin` base class
+- Override hook methods (`after_plan`, `before_apply`, etc.)  
+- Define parameters, contexts, webhooks, and policies using pydantic dataclasses
+- Include automatic validation of data structures (e.g., Variables must have either `value` or `value_from_parameter`)
+- Are automatically converted to Spacelift plugin YAML format with JSON schema validation
+
+## Available Plugins
+
+- **wiz** - Security scanning plugin for infrastructure as code
+
+## Development
+
+### Commands
+
+```bash
+# Generate plugin YAML
+python -m spaceforge generate [plugin_file.py] [-o output.yaml]
+
+# Test plugin execution
+python -m spaceforge runner [--plugin-file plugin.py] hook_name
+
+# Get help
+python -m spaceforge --help
+```
+
+### Framework Documentation
+
+See [spaceforge/README.md](spaceforge/README.md) for detailed framework documentation.
+
+## Contributing
+
+1. Create your plugin in a new directory
+2. Follow the plugin development patterns shown in existing plugins
+3. Generate and test your plugin YAML
+4. Submit a pull request
+
+## License
+
+MIT License

spaceforge-0.1.0.dev0.dist-info/RECORD

@@ -0,0 +1,19 @@
+spaceforge/README.md,sha256=8o1Nuyasb4OxX3E7ZycyducOrR4J19bZcHrLvFeoFNg,7730
+spaceforge/__init__.py,sha256=jsfbVuAa-7QX5XCu-d1rGc2qP9Iw1zQOu9ARJM9sm1k,516
+spaceforge/__main__.py,sha256=gqj_EAEshdkwcXfERLnyAWveGDoXYJPwPa17BDMSMSA,613
+spaceforge/_version.py,sha256=KLlA-mMwGoc8dP7BQAzLprWKT_n6k13anGYGEvf47GA,2166
+spaceforge/cls.py,sha256=-oNXg75ddexgU3eo0MtO_1Nv3QiAPEHLqB_r8WJQ7tw,5791
+spaceforge/cls_test.py,sha256=nXAgbnFnGdFxrtA7vNXiePjNUASuoYW-lEuQGx9WMGs,468
+spaceforge/generator.py,sha256=myAn8C-15S3KKiYUDfaT1UeMdtFBkFA9jKXGV2Ux4l0,13672
+spaceforge/generator_test.py,sha256=CGQOD0WrBbbbg6tgiEKo_KZp5nT6GpZdThWRv2VAhsU,23068
+spaceforge/plugin.py,sha256=NHCQg01OTWvnUMOpBQAq4rkJQ61coLE-xrG1zV8Hjn8,9549
+spaceforge/plugin_test.py,sha256=eTCIVU9VGx0j_rt_L-9HjB0rR6K0Fw-8uQ86pZjNna8,23003
+spaceforge/runner.py,sha256=JSABlCiq_qs9knWEq6eUpEE_ZR-r0KcDQLzxErd324Y,3457
+spaceforge/runner_test.py,sha256=fws8RaWbZLLek7CQJ-PJjGLsgAMdPXgnHxIYBTRRm4Q,19702
+spaceforge/schema.json,sha256=h3G0K5AYXC5p0YCpf8NWlvhzxuvy-SvL4zWWHOUkTpU,10134
+spaceforge-0.1.0.dev0.dist-info/licenses/LICENSE,sha256=wyljRrfnWY2ggQKkSCg3Nw2hxwPMmupopaKs9Kpgys8,1065
+spaceforge-0.1.0.dev0.dist-info/METADATA,sha256=vmdK_0BZNPhPVsx_9UkgEUR0V8Fked_dnWPFxUlxyMQ,4588
+spaceforge-0.1.0.dev0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+spaceforge-0.1.0.dev0.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
+spaceforge-0.1.0.dev0.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
+spaceforge-0.1.0.dev0.dist-info/RECORD,,

spaceforge-0.1.0.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

spaceforge-0.1.0.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+spaceforge = spaceforge.__main__:main

spaceforge-0.1.0.dev0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Spacelift
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

spaceforge-0.1.0.dev0.dist-info/top_level.txt

@@ -0,0 +1 @@
+spaceforge