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.3.0.tar.gz
(34.3 kB
view hashes)
Built Distributions
Close
Hashes for sideko_py-0.3.0-cp38-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 181c358f047a35c23486ee2b72690cf8fee8bcba9340c058e5e799752127a635 |
|
MD5 | e2daa4aeef205f4cb7ce8d7b01fab508 |
|
BLAKE2b-256 | c651e66960984aea59b7f9191989da6856787345436f8792a6cf8b32bfc5dc6d |
Close
Hashes for sideko_py-0.3.0-cp38-abi3-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b3b46dac237f9bebb4be5c84369e5b56f7485aa4ec924765ba900b334e96c4b |
|
MD5 | 7c917e2a47ea4f7c0210c3451d95c918 |
|
BLAKE2b-256 | 179762c04fcdc204d4214f9c0408dbd46a2f88a30ba0cc41934fb5af39efc9d9 |
Close
Hashes for sideko_py-0.3.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1113cd2fca187018aec29015b8e7a4e95bcf4b9caf404192c97b0b9d4c005a78 |
|
MD5 | d9c2d0a0b867192af487da066e56d2de |
|
BLAKE2b-256 | 6f4f783c3c5fb37349871789666217606dd3bb83ebf47ba0e88ac9f83297712a |
Close
Hashes for sideko_py-0.3.0-cp38-abi3-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45ab3c804ae1a52aaf959a3752a35d0c44ac9e4d934684b4b3b0ed9fec36e715 |
|
MD5 | f5289153c05478966f13e0fa0d718a20 |
|
BLAKE2b-256 | 7055ea6e7999a7640b8a7d27507e03fb50b1eb866cc5d744a476f042704f7579 |
Close
Hashes for sideko_py-0.3.0-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76fed0cb3358d6b75aa5914c32ab9242bb8f557261f55c1076af56548fc8e95c |
|
MD5 | 79c949c5ef5d22b5137cea29a94e657c |
|
BLAKE2b-256 | a7078cde168f24109913cf74b1177f7c672cca799ba9893f3c84c86265727210 |
Close
Hashes for sideko_py-0.3.0-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f203f4ae52a39d8b67a62da29aef99d27d8040fc36a54d92b8a18aaff3efc8a6 |
|
MD5 | bbf16872fdebec7ceb53e21857cd38d3 |
|
BLAKE2b-256 | 578a3a01f27c695c7e912b0d118fcbcbd1a355111e5cc5a60e8af96cc4bd7871 |