Borea Python HTTP Client SDK Generator

Borea Python HTTP Client SDK Generator

The Borea Python HTTP Client SDK Generator is a powerful tool designed to streamline the process of generating a Python client based on an OpenAPI specification. This project aims to facilitate developers in leveraging the capabilities of the Borea platform through efficient SDK creation.

Key Features

• Easy Setup: Quickly set up the generator using a simple automated script. The setup not only creates a dedicated Python virtual environment but also installs all necessary dependencies, ensuring a seamless start.

• OpenAPI Integration: The generator accepts an OpenAPI specification file (openapi.json) to produce a fully functional Python HTTP client SDK. This capability makes it easy to interact with APIs defined through OpenAPI, enhancing productivity and reducing errors.

Quick Installation

To initiate the setup, run the provided script that configures the virtual environment and installs dependencies:

source ./setup.sh

Alternatively, manual setup steps are available for those who prefer a more tailored approach, allowing for flexibility depending on the user's environment.

Usage Instructions

After setting up the project, ensure that the OpenAPI specification is available in the root directory. Execute the SDK generator with the following command:

python -m src.python_sdk_generator.python_sdk_generator

This command generates the Python HTTP client SDK according to the defined OpenAPI specification.

Configuration Options

Customization is made straightforward with the borea.config.json configuration file, which facilitates defining input and output options. Key settings include:

• Input: Specify the OpenAPI file or URL.
• Output: Designate directories for the generated client SDK and models.
• Ignore Patterns: Configure patterns for files or directories to be excluded from generation.

Command Line Interface

The command line interface provides flexibility with various options, allowing users to generate SDKs with custom configurations directly from the terminal. For example:

python -m src.python_sdk_generator.python_sdk_generator --help

This command displays all available options, aiding in efficient use of the generator.

Project Structure

The repository is organized for ease of use, featuring directories for the source code, configuration files, and the virtual environment:

• src/: The core source code for the SDK generator.
• openapi.json: The OpenAPI specification document.
• borea.config.json: Contains configuration settings.
• .venv/: The created Python virtual environment during setup.

The Borea Python HTTP Client SDK Generator provides a robust framework to enhance API integrations, making it a valuable addition to any developer's toolkit.