qodiqa
SpecificationRun a simulation

Four languages, one contract.

Client libraries for the gateway, installed from the repository.

  • 4 languagesJavaScript, Python, Go, Java
  • Install from sourceno registry
  • Not publishedanywhere
Quickstartsdk folder on GitHub

SDKs

Status, from the evidence matrix.

Statuses come from the capability matrix on the frameworks pages; none of the four is published to a package registry.

  • JavaScript / TypeScript

    partly verifiednot published
    Package
    @qodiqa/sdk
    Version
    1.0.0
    Requires
    Node.js 18 or later
    Protocol
    V1 and V2 calls
    Install
    # in the gateway repository root: build the SDK (needs network access; dist/ is not committed)
npm run sdk:build

# in your project: install from the local path
npm install /path/to/qodiqa-gateway/sdk/javascript
    Guidesdk/javascript

  • Python

    partly verifiednot published
    Package
    qodiqa
    Version
    1.0.0
    Requires
    Python 3.9 or later
    Protocol
    V1 and V2 agent calls
    Install
    pip install /path/to/qodiqa-gateway/sdk/python      # or, for development: pip install -e sdk/python
    Guidesdk/python

  • Go

    unassessednot published
    Package
    github.com/qodiqa/qodiqa-go (provisional module path)
    Version
    none declared
    Requires
    Go 1.21 or later, standard library only
    Protocol
    V1 only
    Install
    # from sdk/go in the gateway repository
go test ./...
    Guidesdk/go

  • Java

    unassessednot published
    Package
    dev.qodiqa:qodiqa-sdk (provisional coordinates)
    Version
    1.0.0
    Requires
    Java 17 or later, one runtime dependency
    Protocol
    V1 only
    Install
    # from sdk/java in the gateway repository
mvn test
    Guidesdk/java
  • JavaScriptV1 and V2 calls
  • PythonV1 and V2 agent calls
  • GoV1 only
  • JavaV1 only

Write your own

Write your own

Write your own

Independent implementations are welcome. The normative protocol and the published test vectors are everything you need to check one.

SpecificationTest vectorsProtocol text