Skip to content

Commit a84160b

Browse files
docs: updated python package with docs and published
1 parent 75ea830 commit a84160b

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# speakeasy-client-sdk-python
2+
3+
This is the Speakeasy API Client SDK for Python. It is generated from our OpenAPI spec found at https://docs.speakeasyapi.dev/openapi.yaml and used for interacting with the [Speakeasy API](https://docs.speakeasyapi.dev/docs/speakeasy-api/speakeasy-api).
4+
5+
This SDK was generated using Speakeasy's SDK Generator. For more information on how to use the generator to generate your own SDKs, please see the [Speakeasy Client SDK Generator Docs](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks).
6+
7+
## Installation
8+
9+
```bash
10+
pip install speakeasy-client-sdk-python
11+
```
12+
13+
## Example usage
14+
```python
15+
import sdk
16+
from sdk.models import operations, shared
17+
18+
s = sdk.SDK()
19+
s.config_security(
20+
security=shared.Security(
21+
api_key=shared.SchemeAPIKey(
22+
api_key="YOUR_API_KEY" # Replace with your API key from your Speakeasy Workspace
23+
)
24+
)
25+
)
26+
27+
req = operations.GetApisRequest(
28+
query_params=operations.GetApisQueryParams(
29+
metadata={'label': ['1']},
30+
op=operations.GetApisOp(and_=True)
31+
)
32+
)
33+
34+
res = s.get_apis(req)
35+
36+
if res.status_code == 200:
37+
print(res.apis)
38+
else:
39+
print(res.error)
40+
41+
```

gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
python:
22
packagename: speakeasy-client-sdk-python
3-
version: 0.0.4
3+
version: 0.2.0
44
author: Speakeasy
55
description: Speakeasy API Client SDK for Python

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="speakeasy-client-sdk-python",
8-
version="0.0.4",
8+
version="0.2.0",
99
author="Speakeasy",
1010
description="Speakeasy API Client SDK for Python",
1111
long_description=long_description,

0 commit comments

Comments
 (0)