splunk-soar-sdk 2.3.2__py3-none-any.whl → 2.3.4__py3-none-any.whl

soar_sdk/app_templates/basic_app/.pre-commit-config.yaml

@@ -1,11 +1,84 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+# By default, run each hook only in the standard pre-commit stage
+default_install_hook_types: [pre-commit, commit-msg]
+default_stages: [pre-commit]
+
+# This is a template for connector pre-commit hooks
 repos:
--   repo: https://github.com/phantomcyber/dev-cicd-tools
-    rev: v1.26
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.1.0
     hooks:
-    -   id: org-hook
-    -   id: package-app-dependencies
--   repo: https://github.com/Yelp/detect-secrets
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [--verbose]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+        exclude: ^NOTICE$
+        exclude_types: [ markdown ]
+      - id: trailing-whitespace
+        exclude: ^NOTICE$
+        exclude_types: [ markdown ]
+      - id: requirements-txt-fixer
+      - id: check-json
+      - id: check-yaml
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.7
+    hooks:
+      - id: ruff
+        args: [ "--fix", "--unsafe-fixes"] # Allow unsafe fixes (ruff pretty strict about what it can fix)
+      - id: ruff-format
+  - repo: https://github.com/djlint/djLint
+    rev: v1.36.4
+    hooks:
+      - id: djlint-reformat-django
+      - id: djlint-django
+  - repo: https://github.com/phantomcyber/soar-app-linter
+    rev: 0.1.0
+    hooks:
+      - id: soar-app-linter
+        args: ["--single-repo", "--message-level", "error"]
+  - repo: https://github.com/hukkin/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        exclude: "release_notes/.*"
+  - repo: https://github.com/returntocorp/semgrep
+    rev: v1.89.0
+    hooks:
+      - id: semgrep
+  - repo: https://github.com/Yelp/detect-secrets
     rev: v1.5.0
     hooks:
-    -   id: detect-secrets
+      - id: detect-secrets
         args: ['--no-verify']
+        exclude_types: [json]
+        exclude: "README.md"
+  # Central hooks
+  - repo: https://github.com/phantomcyber/dev-cicd-tools
+    rev: v2.1.0
+    hooks:
+      - id: build-docs
+        language: python
+        additional_dependencies: ["local-hooks"]
+        args: ['.']
+      - id: copyright
+        language: python
+        additional_dependencies: ["local-hooks"]
+        args: ['.']
+      - id: notice-file
+        language: python
+        additional_dependencies: ["local-hooks"]
+        args: ['.']
+      - id: release-notes
+        language: python
+        additional_dependencies: ["local-hooks"]
+        args: ['.']
+      - id: static-tests
+        language: python
+        additional_dependencies: ["local-hooks"]
+        args: ['.']

soar_sdk/cli/init/cli.py

@@ -190,6 +190,10 @@ def init_sdk_app(
     app_text = ast.unparse(app_module)
     (app_dir / "src/app.py").write_text(app_text)
 
+    release_notes_dir = app_dir / "release_notes"
+    release_notes_dir.mkdir(exist_ok=True)
+    (release_notes_dir / "unreleased.md").write_text("**Unreleased**\n")
+
     uv_path = shutil.which("uv")
     if not uv_path:
         rprint("[red]uv command not found. Please install uv to continue.[/]")

soar_sdk/params.py

@@ -218,26 +218,27 @@ class MakeRequestParams(Params):
     )
 
     headers: str = Param(
-        description="The headers to send with the request (JSON object).",
+        description="The headers to send with the request (JSON object). An example is {'Content-Type': 'application/json'}",
         required=False,
     )
 
     query_parameters: str = Param(
-        description="The query string to send with the request.",
+        description="Parameters to append to the URL (JSON object or query string). An example is ?key=value&key2=value2",
         required=False,
     )
 
     body: str = Param(
-        description="The body to send with the request (JSON object).",
+        description="The body to send with the request (JSON object). An example is {'key': 'value', 'key2': 'value2'}",
         required=False,
     )
 
     timeout: int = Param(
-        description="The timeout for the request.",
+        description="The timeout for the request in seconds.",
         required=False,
     )
 
     verify_ssl: bool = Param(
-        description="Whether to verify the SSL certificate.",
+        description="Whether to verify the SSL certificate. Default is False.",
         required=False,
+        default=False,
     )

{splunk_soar_sdk-2.3.2.dist-info → splunk_soar_sdk-2.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.3.2
+Version: 2.3.4
 Summary: The official framework for developing and testing Splunk SOAR Apps
 Project-URL: Homepage, https://github.com/phantomcyber/splunk-soar-sdk
 Project-URL: Documentation, https://github.com/phantomcyber/splunk-soar-sdk

{splunk_soar_sdk-2.3.2.dist-info → splunk_soar_sdk-2.3.4.dist-info}/RECORD

@@ -13,7 +13,7 @@ soar_sdk/crypto.py,sha256=qiBMHUQqgn5lPI1DbujSj700s89FuLJrkQgCO9_eBn4,392
 soar_sdk/exceptions.py,sha256=CxJ_Q6N1jlknO_3ItDQNhHEw2pNWZr3sMLqutYmr5HA,1863
 soar_sdk/input_spec.py,sha256=BAa36l8IKDvM8SVMjgZ1XcnWZ2F7O052n2415tLeKK8,4690
 soar_sdk/logging.py,sha256=lSz8PA6hOCw2MHGE0ZSKbw-FzSr1WdbfQ7BHnXBUUY0,11440
-soar_sdk/params.py,sha256=OomwUt2bkOwzDs9ypmf-ziZmj2D4uIieO85Jo3haWCg,8731
+soar_sdk/params.py,sha256=UXfyCAO3bqMX7n_2Cmu-ObmilBkGg0kX1Jk9KCjjrtY,8940
 soar_sdk/paths.py,sha256=XhpanQCAiTXaulRx440oKu36mnll7P05TethHXgMpgQ,239
 soar_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/types.py,sha256=uMFnNOHpmCLrbAhQOgmXjScXiGE67sM8ySN04MhkC3U,602
@@ -23,7 +23,7 @@ soar_sdk/apis/container.py,sha256=eLV3S1zvwfMerNXM78gsSqiMDv731oVwBcdfQJdxSn4,87
 soar_sdk/apis/utils.py,sha256=lyqVGVRzRfCmel0k678CSD4tVASXkVZGm4Qzee2KbyM,982
 soar_sdk/apis/vault.py,sha256=nOIi7oqrBl59AfI1i0zWxfj-TO24x02_RYLSgT0rXNY,8565
 soar_sdk/app_templates/basic_app/.gitignore,sha256=CwSrCn9YISq7Q2EJVc7o1kdkXqysZngGJfz-4pOMMdY,3517
-soar_sdk/app_templates/basic_app/.pre-commit-config.yaml,sha256=Oj171mepUB5OEl6idIYPfF9Hrr21wDzlkeK-eR6FIQg,281
+soar_sdk/app_templates/basic_app/.pre-commit-config.yaml,sha256=0sFjnoC-scXm80ZgA4TPyc6BN1VaF4eY9p8qwEchB38,2526
 soar_sdk/app_templates/basic_app/logo.svg,sha256=_JTop6spn5oPWPk-w6Tzumx_FTSBanOYra3vE2FO-6c,285
 soar_sdk/app_templates/basic_app/logo_dark.svg,sha256=PTxIs_1CKK9ZY3v-K1QoGwaUng9ZUL2MhUeO2jeHu_0,291
 soar_sdk/app_templates/basic_app/uv.lock,sha256=AfgaIBg88KH-0iyXpCXacXAwHYKm0c-on2gWXjV9L-Y,80216
@@ -33,7 +33,7 @@ soar_sdk/cli/cli.py,sha256=62n6b41bjXILtkqLTpeID8JyDYMbkfXNV1LCo52YUsA,926
 soar_sdk/cli/path_utils.py,sha256=rFJDAe-sTC_6KgSiidlD3JcpygFmyHAEsn1j_6eWpIc,1263
 soar_sdk/cli/utils.py,sha256=GNZLFAMH_BKQo2-D5GvweWxeuR7DfR8eMZS4-sJUggU,1441
 soar_sdk/cli/init/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-soar_sdk/cli/init/cli.py,sha256=rRt_Rho-mKHYivQzcSKtakFGM6hie0-bQ4D-5O1gjII,14507
+soar_sdk/cli/init/cli.py,sha256=FU9N0pMGUoNA0qHnA3m63vfytmXPHpHxHep-D-T16-c,14674
 soar_sdk/cli/manifests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/cli/manifests/cli.py,sha256=cly5xVdj4bBIdZVMQPIWTXRgUfd1ON3qKO-76Fwql18,524
 soar_sdk/cli/manifests/deserializers.py,sha256=xFTRzWEszKbkO-yNUvGnQfjdJryXpB2FalkxaDmzm3Y,16589
@@ -96,8 +96,8 @@ soar_sdk/views/components/pie_chart.py,sha256=LVTeHVJN6nf2vjUs9y7PDBhS0U1fKW750l
 soar_sdk/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/webhooks/models.py,sha256=-rjuFA9cRX5zTLp7cHSHVTkt5eVJD6BdESGbj_qkyHI,4540
 soar_sdk/webhooks/routing.py,sha256=BKbURSrBPdOTS5UFL-mHzFEr-Fj04mJMx9KeiPrZ2VQ,6872
-splunk_soar_sdk-2.3.2.dist-info/METADATA,sha256=995bovTLwLBvV4GCEKW5rzi93BCmrwPBiECkFpLciAQ,7361
-splunk_soar_sdk-2.3.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-2.3.2.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-2.3.2.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-2.3.2.dist-info/RECORD,,
+splunk_soar_sdk-2.3.4.dist-info/METADATA,sha256=U0BNBr8ZFSOR7hfUx2qQP-Wn5p4zcabzTo8U0xowIpY,7361
+splunk_soar_sdk-2.3.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-2.3.4.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-2.3.4.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-2.3.4.dist-info/RECORD,,