sideko-py 0.10.0

No project description provided

Sideko-Python

SDK client generator for HTTP APIs using OpenApi.

Supports OpenApi 3.x and can generate clients in Python, Ruby, Rust, Typescript, and Go.

This package will also install the sideko CLI, find the CLI's documentation on our Github.

Installation

pip install sideko-py

Usage

Configure API key

You need a Sideko API Key to generate SDKs. Create one for free by either:

1. Signing up / logging in via the CLI, or
2. Signing up / logging in at app.sideko.dev (User Icon > API Keys)

sideko login
# Complete login via browser pop-up

Run sideko login --help to list all options.

The API key is read from (in order of priority):

• $PWD/.sideko
• $HOME/.sideko
• SIDEKO_API_KEY environment variable

Generate

import sideko_py

# The openAPI source can be a URL, Path, or json/yml raw spec (as a string)
openapi_src = "https://your-spec.yml"
sideko_py.generate_sdk(sideko_py.Language.Python, openapi_src, "./sdk-out")

Local development

This rust crate uses PyO3 & Maturin to create and distribute python bindings to generate SDKs with Sideko.

Assumes rust / cargo / python >= 3.8 is installed

1. Create & activate virtual python environment

python3 -m venv .venv
source .venv/bin/activate

2. Install maturin

pip install maturin
# macOS users can also install with `brew install maturin`

3. Build & install python module

maturin develop

4. Try it out in a python shell

python

>>> import sideko_py