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.4.0.tar.gz
(34.2 kB
view hashes)
Built Distributions
Close
Hashes for sideko_py-0.4.0-cp38-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec772df7441f66e4ca071807ccd4350a8aff6d3640c317b2cf287eeafa3dcecb |
|
MD5 | 1d010d0b839bad42722084a1b11e39ae |
|
BLAKE2b-256 | fce35c021367c641be99dd488c220af8d9824cb9b3d1621c62e15437d370f29e |
Close
Hashes for sideko_py-0.4.0-cp38-abi3-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f01447e327a81cfe68448b6c148bb4b1cf4043219331b9ad2850017d5f8c549e |
|
MD5 | c9ebde31fc822dfd569036023930712d |
|
BLAKE2b-256 | 210fdfe2cb3bb8d0cae4d0651e7e1d056fa6612e76b1560c00b92024a9726223 |
Close
Hashes for sideko_py-0.4.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3da6cb1bfb035cdfdf735d75ef03dcaa88d315c48212fb181d78060e74acdec4 |
|
MD5 | fb2e01668808f28232e4022f46b6b9de |
|
BLAKE2b-256 | 0747b52e5058d03e8fa289d4a45f989ac5f496947c1aa2c0fa935bfadd3976fd |
Close
Hashes for sideko_py-0.4.0-cp38-abi3-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8308ba2c5bae82fcf013a9e76b3cb167a575ddeb91e6ef437bd50f25ce61c44 |
|
MD5 | cef335ccf9c7a1be4e5185ae4b30cfd3 |
|
BLAKE2b-256 | 63c3f9b3e25eeaff02014be9246108e32606057401538d4a49869f649b5ba2ea |
Close
Hashes for sideko_py-0.4.0-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83f06d52b1d8be0eeadde09d6bec49e3e3cb9ab23d03ce472fe790a39d814b77 |
|
MD5 | 20a3a81f6f2ab9e6bb9995b6e69bec8f |
|
BLAKE2b-256 | 3742c3963a6e8b1ed9d7e635f5ed202331be773f3a804b0fec6bd50761b31c93 |
Close
Hashes for sideko_py-0.4.0-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0946419603c48d73ff2eb6e48d9e752a47bd13765fab98c4889d05ed8c9c97e6 |
|
MD5 | 7d5e6a354b3260e00e3fd04c67831014 |
|
BLAKE2b-256 | affabf961d51c4d3a21ef2c80af483e30b97ee253cc4e21c9c95116d5c2e0f2a |