KBase SDK

The KBase SDK is a set of tools for developing KBase Apps that can be dynamically registered and run on the KBase platform. Apps are grouped into modules that include all code, dependencies, specification files, and documentation needed to define and run Apps in the KBase Narrative interface.

SDK user documentation can be found here

Documentation in this readme is for developing the SDK codebase itself. If you want to develop an app using the SDK, please visit the documentation website linked above.

Running the tests

Requires uv and Java 17.

• Copy test.cfg.example to test.cfg and fill it in appropriately.
• uv sync --dev
  • This only needs to be run prior to the first test run or when the uv dependencies change.
• uv run ./gradlew test

Notes and references

• Building and compiling the SDK from source
• Codebase anatomy

The full build

See doc/test_dependencies.md for some information about how to build all the necessary dependencies to run tests.