spaceforge 0.1.0.dev0__tar.gz

spaceforge-0.1.0.dev0/.github/workflows/release.yml

@@ -0,0 +1,95 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write  # Required for trusted publishing to PyPI
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11']
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Fetch full history for setuptools-scm
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[dev]
+    
+    - name: Run tests
+      run: |
+        python -m pytest spaceforge/ -v
+    
+    - name: Run type checking
+      run: |
+        python -m mypy spaceforge/
+    
+    - name: Check code formatting
+      run: |
+        python -m black --check spaceforge/
+        python -m isort --check-only spaceforge/
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Fetch full history for setuptools-scm
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build setuptools-scm[toml]
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check distribution
+      run: |
+        pip install twine
+        twine check dist/*
+    
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: distribution-files
+        path: dist/
+
+  release:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: release
+    
+    steps:
+    - name: Download build artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: distribution-files
+        path: dist/
+    
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        print-hash: true

spaceforge-0.1.0.dev0/.gitignore

@@ -0,0 +1,196 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+CLAUDE.md
+.claude/**

spaceforge-0.1.0.dev0/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/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include spaceforge *.json
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

spaceforge-0.1.0.dev0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,120 @@
+# 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