Fuzzball Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  2. /
  3. Client SDK
  4. /
  5. SDK Prerequisites

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 haven’t installed it yet, follow the detailed instructions in the CLI installation guide.

  • Apptainer: A container runtime that allows us to execute the Swagger Codegen container. Note that you don’t need to install Swagger itself. We’ll use Apptainer to run a pre-built Swagger Codegen CLI container from Docker Hub.

  • URL to your Fuzzball deployment: You’ll need both:

    • A valid Fuzzball account with appropriate permissions
    • The specific URL of your Fuzzball deployment (Swagger should be pointed to a URL for the Fuzzball web UI to generate the client SDK from the API spec.)

  • Python environment: Since we’re generating a Python SDK, you’ll 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’re ready to proceed with generating your custom Fuzzball SDK.

gdoc_arrow_left_alt Client SDK SDK Generation using Swagger Codegen gdoc_arrow_right_alt