No project description provided
Project description
Sideko-Python
SDK client generator for HTTP APIs using OpenApi.
Supports OpenApi 3 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:
- Signing up / logging in via the CLI, or
- 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://raw.githubusercontent.com/Sideko-Inc/sideko/main/specs/brewdog.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
- Create & activate virtual python environment
python3 -m venv .venv
source .venv/bin/activate
- Install maturin
pip install maturin
# macOS users can also install with `brew install maturin`
- Build & install python module
maturin develop
- Try it out in a python shell
python
>>> import sideko_py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sideko_py-0.1.0.tar.gz
(29.1 kB
view hashes)
Built Distributions
Close
Hashes for sideko_py-0.1.0-cp38-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0cc5ea7719097828ed2287ba4607351bbee7feaf7845e817cae2f4b60a5f0e3 |
|
MD5 | c223e2f35cbe2f21bd224c31141bd28e |
|
BLAKE2b-256 | 6efdcfbe1b60cfd219b7811f709394d884e0786947e1a28472d3cae2ec946dae |
Close
Hashes for sideko_py-0.1.0-cp38-abi3-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78e33d7f21bac18068195e1327a57170dff59e1955c84c44b96a3f3cfd313ad4 |
|
MD5 | a678e7a6aa9d9f2573aa90380d13fd8f |
|
BLAKE2b-256 | 13775de0e97f015136b636b99ba863a3ca836d601d82d177bd1c8f26b9827bb7 |
Close
Hashes for sideko_py-0.1.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfe62d0507297e4d554b8cc897a4abf91e80ecada558397bac1919eea20b9d22 |
|
MD5 | 92f75f06e28a1e9a5d9822b556153e20 |
|
BLAKE2b-256 | d263ab7845fcbd5bf03fc66ad45b3f7df1449d99514c7026140832415215eb41 |
Close
Hashes for sideko_py-0.1.0-cp38-abi3-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2c2084fef2acf35e3a6923144995ff9999ce2ea7b9af82934ae112628d6aab9 |
|
MD5 | e54885927d8100d59712728c73e0687f |
|
BLAKE2b-256 | 24bdf67f9239b960f1631ad15ea29263d8cf9aea66fbd502a9b2b2adeaf73d0c |
Close
Hashes for sideko_py-0.1.0-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05daad2f801a5002cff39327160377d681ee2a7ff3afecf89aff22ce28ba1391 |
|
MD5 | e744dfcd6491da350f715dbb310c7dd1 |
|
BLAKE2b-256 | ff2945c37469a3ae08bea44b5467147cddf1568d31cb7327c8349c5cc9b1f01b |
Close
Hashes for sideko_py-0.1.0-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0910b24b7055ec1c354aa963f4a749809ca5f6af29b61dd4029493b8afa16736 |
|
MD5 | c12a7aee47e65830f7d2e1610e661711 |
|
BLAKE2b-256 | 3f9c1dac923c5b8afa709c639b24267b92095c7ea9ed02039ae186a9b048a6bd |