surety-scaffold 0.0.1__tar.gz

surety_scaffold-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish
+
+on:
+  workflow_run:
+    workflows: ["Create Release"]
+    types: [completed]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

surety_scaffold-0.0.1/.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements/test.txt
+        pip install -e .
+    - name: Analysing the code with pylint
+      run:
+        python -m pylint surety/scaffold tests

surety_scaffold-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Create Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  tag-and-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: pip install build setuptools-scm
+
+      - name: Build package
+        run: python -m build
+
+      - name: Create tag
+        id: tag
+        uses: anothrNick/github-tag-action@1.67.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BUMP: patch
+          WITH_V: true
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.tag.outputs.new_tag }}
+          files: dist/*

surety_scaffold-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    permissions: write-all
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          cache: "pip"
+          cache-dependency-path: |
+            requirements/test.txt
+            pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements/test.txt
+          pip install -e .
+
+      - name: Run tests
+        run: |
+          pytest \
+            --cache-clear \
+            --junitxml=test-report.xml \
+            --cov=surety/scaffold \
+            --cov-report=term-missing:skip-covered \
+            --cov-report=xml \
+            > pytest-coverage.txt
+
+      - name: Pytest coverage comment
+        if: always()
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: pytest-coverage.txt
+          junitxml-path: test-report.xml
+
+      - name: Publish test report
+        if: always()
+        uses: elenakulgavaya/pytest-report-action@v1.3
+        with:
+          path: test-report.xml

surety_scaffold-0.0.1/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# packaging fixes
+*/__init__.pyi
+
+# 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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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 entire 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
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

surety_scaffold-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Elena Kulgavaya
+
+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.

surety_scaffold-0.0.1/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: surety-scaffold
+Version: 0.0.1
+Summary: Code generation for surety contracts
+Author-email: Elena Kulgavaya <elena.kulgavaya@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Elena Kulgavaya
+        
+        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.
+        
+Keywords: api,contract-testing,automation,codegen,surety
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: surety<1.0,>=0.0.4
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: jsonschema>=4.0
+Dynamic: license-file
+
+# surety-scaffold
+
+Code generation toolkit for the [surety](https://github.com/elenakulgavaya/surety) contract-testing framework.
+
+Bootstraps surety schemas, contracts, callers, and test scaffolding from existing JSON payloads, JSON Schema, and OpenAPI specs — so you can start contract-based testing without writing boilerplate by hand.
+
+---
+
+## Installation
+
+```bash
+pip install surety-scaffold
+```
+
+Requires `surety>=0.0.4`.
+
+---
+
+## Features
+
+### Extract contract from JSON
+
+Turn a raw JSON payload into surety `Dictionary` class definitions.
+
+**Programmatic:**
+
+```python
+import json
+from surety.scaffold import extract_from_json
+
+payload = json.dumps({
+    "order_id": 42,
+    "status": "pending",
+    "total": 199.99,
+    "is_express": False,
+    "customer": {
+        "customer_id": 7,
+        "email": "jane@example.com"
+    },
+    "items": [
+        {"sku": "ABC-1", "qty": 2}
+    ]
+})
+
+print(extract_from_json(payload, class_name="Order"))
+```
+
+Output:
+
+```python
+from surety import Array, Bool, Dictionary, Float, Int, String
+
+
+class Customer(Dictionary):
+    CustomerId = Int(name='customer_id', required=True)
+    Email = String(name='email', required=True)
+
+
+class Items(Dictionary):
+    Sku = String(name='sku', required=True)
+    Qty = Int(name='qty', required=True)
+
+
+class Order(Dictionary):
+    OrderId = Int(name='order_id', required=True)
+    Status = String(name='status', required=True)
+    Total = Float(name='total', required=True)
+    IsExpress = Bool(name='is_express', required=True)
+    Customer = Customer(name='customer', required=True)
+    Items = Array(Items, name='items', required=True)
+```
+
+**Type inference rules:**
+
+| JSON value | Surety type |
+|------------|-------------|
+| `true` / `false` | `Bool` |
+| integer | `Int` |
+| float | `Float` |
+| UUID string | `Uuid` |
+| ISO 8601 datetime or date string | `DateTime` |
+| any other string | `String` |
+| object `{}` | nested `Dictionary` subclass |
+| array of objects | `Array(NestedClass, ...)` |
+| array of primitives | `Array(PrimitiveType, ...)` |
+| `null` | `String(allow_none=True)` |
+
+Nested objects produce their own `Dictionary` subclass and are always emitted before the class that references them. Arrays of objects merge all items across the array to capture the full set of fields. Duplicate class names (same key appearing at different nesting levels) are disambiguated automatically with a numeric suffix.
+
+**Key naming:**
+JSON keys are converted to `PascalCase` for both the class attribute name and the generated class name. `snake_case`, `camelCase`, and `kebab-case` are all handled.
+
+---
+
+**CLI:**
+
+```bash
+# Pass JSON as an argument
+surety-scaffold '{"order_id": 1, "status": "pending"}' --class-name Order
+
+# Pipe from a file or command
+cat response.json | surety-scaffold --class-name Order
+
+# Skip clipboard copy
+surety-scaffold '{"x": 1}' --no-clipboard
+```
+
+The result is printed to stdout and automatically copied to the clipboard (`pbcopy` on macOS, `xclip` on Linux).
+
+```
+usage: surety-scaffold [-h] [--class-name CLASS_NAME] [--no-clipboard] [json]
+
+positional arguments:
+  json                  JSON string to extract from. Reads from stdin if omitted.
+
+options:
+  --class-name, -c      Name for the top-level generated class (default: Schema).
+  --no-clipboard        Do not copy the result to the clipboard.
+```
+
+---
+
+## Roadmap
+
+The following features are planned for this library. They complement the core surety framework with static analysis, code generation, and developer tooling.
+
+### In scope for surety-scaffold
+
+| # | Feature | Status |
+|---|---------|--------|
+| 1 | **Extract contract from JSON** — infer surety schemas from raw API responses | done |
+| 4 | **Parse JSON Schema / OpenAPI** — generate surety `Dictionary` classes from JSON Schema or OpenAPI 3.x specs, resolving `$ref` and mapping constraints | planned |
+| 5 | **Generate callers** — produce `ApiContract` boilerplate and caller function stubs from OpenAPI operations | planned |
+| 12 | **Generate test scenarios (basic)** — scaffold positive pytest test cases (required fields, full fields, `with_values` overrides) for a given contract | planned |

surety_scaffold-0.0.1/README.md

@@ -0,0 +1,134 @@
+# surety-scaffold
+
+Code generation toolkit for the [surety](https://github.com/elenakulgavaya/surety) contract-testing framework.
+
+Bootstraps surety schemas, contracts, callers, and test scaffolding from existing JSON payloads, JSON Schema, and OpenAPI specs — so you can start contract-based testing without writing boilerplate by hand.
+
+---
+
+## Installation
+
+```bash
+pip install surety-scaffold
+```
+
+Requires `surety>=0.0.4`.
+
+---
+
+## Features
+
+### Extract contract from JSON
+
+Turn a raw JSON payload into surety `Dictionary` class definitions.
+
+**Programmatic:**
+
+```python
+import json
+from surety.scaffold import extract_from_json
+
+payload = json.dumps({
+    "order_id": 42,
+    "status": "pending",
+    "total": 199.99,
+    "is_express": False,
+    "customer": {
+        "customer_id": 7,
+        "email": "jane@example.com"
+    },
+    "items": [
+        {"sku": "ABC-1", "qty": 2}
+    ]
+})
+
+print(extract_from_json(payload, class_name="Order"))
+```
+
+Output:
+
+```python
+from surety import Array, Bool, Dictionary, Float, Int, String
+
+
+class Customer(Dictionary):
+    CustomerId = Int(name='customer_id', required=True)
+    Email = String(name='email', required=True)
+
+
+class Items(Dictionary):
+    Sku = String(name='sku', required=True)
+    Qty = Int(name='qty', required=True)
+
+
+class Order(Dictionary):
+    OrderId = Int(name='order_id', required=True)
+    Status = String(name='status', required=True)
+    Total = Float(name='total', required=True)
+    IsExpress = Bool(name='is_express', required=True)
+    Customer = Customer(name='customer', required=True)
+    Items = Array(Items, name='items', required=True)
+```
+
+**Type inference rules:**
+
+| JSON value | Surety type |
+|------------|-------------|
+| `true` / `false` | `Bool` |
+| integer | `Int` |
+| float | `Float` |
+| UUID string | `Uuid` |
+| ISO 8601 datetime or date string | `DateTime` |
+| any other string | `String` |
+| object `{}` | nested `Dictionary` subclass |
+| array of objects | `Array(NestedClass, ...)` |
+| array of primitives | `Array(PrimitiveType, ...)` |
+| `null` | `String(allow_none=True)` |
+
+Nested objects produce their own `Dictionary` subclass and are always emitted before the class that references them. Arrays of objects merge all items across the array to capture the full set of fields. Duplicate class names (same key appearing at different nesting levels) are disambiguated automatically with a numeric suffix.
+
+**Key naming:**
+JSON keys are converted to `PascalCase` for both the class attribute name and the generated class name. `snake_case`, `camelCase`, and `kebab-case` are all handled.
+
+---
+
+**CLI:**
+
+```bash
+# Pass JSON as an argument
+surety-scaffold '{"order_id": 1, "status": "pending"}' --class-name Order
+
+# Pipe from a file or command
+cat response.json | surety-scaffold --class-name Order
+
+# Skip clipboard copy
+surety-scaffold '{"x": 1}' --no-clipboard
+```
+
+The result is printed to stdout and automatically copied to the clipboard (`pbcopy` on macOS, `xclip` on Linux).
+
+```
+usage: surety-scaffold [-h] [--class-name CLASS_NAME] [--no-clipboard] [json]
+
+positional arguments:
+  json                  JSON string to extract from. Reads from stdin if omitted.
+
+options:
+  --class-name, -c      Name for the top-level generated class (default: Schema).
+  --no-clipboard        Do not copy the result to the clipboard.
+```
+
+---
+
+## Roadmap
+
+The following features are planned for this library. They complement the core surety framework with static analysis, code generation, and developer tooling.
+
+### In scope for surety-scaffold
+
+| # | Feature | Status |
+|---|---------|--------|
+| 1 | **Extract contract from JSON** — infer surety schemas from raw API responses | done |
+| 4 | **Parse JSON Schema / OpenAPI** — generate surety `Dictionary` classes from JSON Schema or OpenAPI 3.x specs, resolving `$ref` and mapping constraints | planned |
+| 5 | **Generate callers** — produce `ApiContract` boilerplate and caller function stubs from OpenAPI operations | planned |
+| 12 | **Generate test scenarios (basic)** — scaffold positive pytest test cases (required fields, full fields, `with_values` overrides) for a given contract | planned |