OpenSOAR SDK
Python SDK for building integrations and playbooks for the OpenSOAR SOAR platform.
Install
pip install opensoar-sdk
Build an Integration
from opensoar_sdk import Integration, action
class MyIntegration(Integration):
name = "my-tool"
async def connect(self):
self.client = MyToolClient(self.config["api_key"])
async def health_check(self) -> bool:
return await self.client.ping()
@action(timeout=30, retries=2)
async def lookup_ip(self, ip: str) -> dict:
return await self.client.query(ip)
Write a Playbook
from opensoar_sdk import playbook, action
@playbook(trigger="webhook", conditions={"severity": ["high", "critical"]})
async def triage_alert(alert):
result = await enrich_ip(alert.source_ip)
if result.malicious:
await block_ip(alert.source_ip)
await notify_slack(f"Blocked {alert.source_ip}")
Testing
from opensoar_sdk.testing import mock_alert, mock_run_context
async def test_my_playbook():
alert = mock_alert(severity="high", source_ip="1.2.3.4")
async with mock_run_context():
await triage_alert(alert)
Part of OpenSOAR
See the main repo for full documentation.
1 maintainer
Metadata
1 maintainer
Release files for opensoar-sdk 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| opensoar_sdk-0.1.1.tar.gz | 6.9 kB | With provenance | Details for opensoar_sdk-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| opensoar_sdk-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for opensoar_sdk-0.1.1-py3-none-any.whl |
Total release size: 14.6 kB
Release files / opensoar_sdk-0.1.1.tar.gz
| Download URL | opensoar_sdk-0.1.1.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
141b1b2f5dc07a4598a9c0d748afab816009da634cd384a039b624546e7b5f9a
|
|
BLAKE2b-256 checksum How to use checksums |
5c96b9addb3409e78ad47950b3588d048b72d14ae0b87612b5c544160615aa52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 13, 2026.
Transparency logRelease files / opensoar_sdk-0.1.1-py3-none-any.whl
| Download URL | opensoar_sdk-0.1.1-py3-none-any.whl |
|---|---|
| Size | 7.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4a9003f9647c71d5b392e99e120c39451ec3060c413a6c2ed4739d02b3bfbfb7
|
|
BLAKE2b-256 checksum How to use checksums |
c9e409da3f0b2e6d6f2c2e3680bbed320d304405e382aba36f8760c31c4ca0d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 13, 2026.
Transparency logSecurity for opensoar-sdk 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for opensoar_sdk-0.1.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 13, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
