Fuzzball Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

SDK Prerequisites

Before proceeding with the SDK generation and installation process, please ensure you have the following prerequisites configured in your environment:

  • Fuzzball CLI: The command-line interface for Fuzzball operations. If you have not installed it yet, follow the detailed instructions in the CLI installation guide.

  • Apptainer: A container runtime. These instructions use Apptainer to run the Swagger Codegen container. Note that you do not need to install Swagger itself. We will use Apptainer to run a pre-built Swagger Codegen CLI container from Docker Hub.

  • A Fuzzball account with permission to reach the API of the deployment you are targeting.

  • The URL of your Fuzzball deployment’s API endpoint: point Swagger Codegen at https://api.<your fuzzball domain>/v4/schema.

  • Python environment: Since we are generating a Python SDK, you will need a functioning Python installation (version 3.6 or newer recommended) where you can install and test the generated package.

After confirming you have all these components in place, you are ready to proceed with generating your custom Fuzzball SDK.