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.1.tar.gz
(29.1 kB
view hashes)
Built Distributions
Close
Hashes for sideko_py-0.1.1-cp38-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a81498a25448a18ca4f25b348349586a886bc7bff10184bd8a783640a6e2b6a |
|
MD5 | a8d8d351ff9dbc9a9c4e2594a7c7601d |
|
BLAKE2b-256 | c9d8e2263ff108079a90eb2250f7ec2ebddc2bbc466bc5dc9a1b928df484fb09 |
Close
Hashes for sideko_py-0.1.1-cp38-abi3-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afaf496907784972192bbe24e16ed16742d7c21581cdc3b0158bc27258ad5323 |
|
MD5 | e0f47c2d8edd9e403f3eff053d4845ea |
|
BLAKE2b-256 | 1806550ae4244af12e561d81e3010fd92ff4ff539cfa54ce2ba8c91c102ad207 |
Close
Hashes for sideko_py-0.1.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b0e31cb968b76104651f2646bd4023a351a9276cbaeb9e8e39b8a5484fa2a34 |
|
MD5 | 68d5337c20d2415382768cfe0bb3164f |
|
BLAKE2b-256 | ddc78e543c8576ca1fddb28592d59f3fb38c0486298929d68c8e8030b3a210f4 |
Close
Hashes for sideko_py-0.1.1-cp38-abi3-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 184a1bdfeb8e677f16ae22de444ed40c64f4f5d470e6d265ff12711612b0767d |
|
MD5 | c8283dc1db8e99f07eb82dc37ae758f3 |
|
BLAKE2b-256 | 2a06070158b18de66a102fedd148069056f1e6ea3fb8c7c373e17fe3af71420e |
Close
Hashes for sideko_py-0.1.1-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c21cc9ccbe21be641afe169c184fde5c2bd8aa30935a283bc4835252188a4b3 |
|
MD5 | 03260692d3420a1ffdfcb80b1addc2f7 |
|
BLAKE2b-256 | bfe7b39180091572f6ad25cbf55103098818366620968d3c6f36d0ea6c77a33a |
Close
Hashes for sideko_py-0.1.1-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19c4861dade11dc9091795975cf22675dcc290fd25b3c68dfaa9305606155354 |
|
MD5 | 884b1f5d4d00596cf18995b6a094d528 |
|
BLAKE2b-256 | 560ec6ce50e3aee0938404a11ece0bb88078bf33ff98f91f7ec0f584bd776712 |