Skip to content

Commit d2b838a

Browse files
committed
update the readme
1 parent ebe02aa commit d2b838a

File tree

6 files changed

+14
-19
lines changed

6 files changed

+14
-19
lines changed

.speakeasy/gen.lock

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ management:
55
docVersion: 1.0.1
66
speakeasyVersion: 1.631.4
77
generationVersion: 2.716.16
8-
releaseVersion: 0.5.5
9-
configChecksum: c272fd869c7b4456e9a143187eebe8be
8+
releaseVersion: 0.5.6
9+
configChecksum: 5c3946002697625b2cb1ae3a4dfce9af
10+
published: true
1011
features:
1112
python:
1213
additionalDependencies: 1.0.0

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ generation:
2828
compile:
2929
enabled: false
3030
python:
31-
version: 0.5.5
31+
version: 0.5.6
3232
additionalDependencies:
3333
dev: {}
3434
main: {}

.speakeasy/workflow.lock

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ targets:
1414
sourceRevisionDigest: sha256:979591ab54418fcfcf6bb36ba4aa4748231411d7d9612b3d60aec41003fde169
1515
sourceBlobDigest: sha256:0af17f076ed8196f10613e2f3081b45456c15f67bc75ca7a2f569bf55d9bca8a
1616
codeSamplesNamespace: bolt-python-api-code-samples
17-
codeSamplesRevisionDigest: sha256:36b7d722795affd99bfba79792072019359acf6ba365167f7b2614d2643a0516
17+
codeSamplesRevisionDigest: sha256:b2ae1de49eb37e75145bff16bf80714605249cc212a90f5402b20b5ec9aafb86
1818
workflow:
1919
workflowVersion: 1.0.0
2020
speakeasyVersion: latest
@@ -29,6 +29,9 @@ workflow:
2929
bolt-sdk:
3030
target: python
3131
source: bolt-python-api
32+
publish:
33+
pypi:
34+
token: $pypi_token
3235
codeSamples:
3336
registry:
3437
location: registry.speakeasyapi.dev/bolt/boltpublicapi/bolt-python-api-code-samples

README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,6 @@ Developer-friendly & type-safe Python SDK specifically catered to leverage *bolt
99
</a>
1010
</div>
1111

12-
13-
<br /><br />
14-
> [!IMPORTANT]
15-
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/bolt/boltpublicapi). Delete this section before > publishing to a package manager.
16-
1712
<!-- Start Summary [summary] -->
1813
## Summary
1914

@@ -52,10 +47,6 @@ Bolt API Reference: Postman Collection:
5247
<!-- Start SDK Installation [installation] -->
5348
## SDK Installation
5449

55-
> [!TIP]
56-
> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
57-
58-
5950
> [!NOTE]
6051
> **Python version upgrade policy**
6152
>
@@ -68,23 +59,23 @@ The SDK can be installed with *uv*, *pip*, or *poetry* package managers.
6859
*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
6960

7061
```bash
71-
uv add git+<UNSET>.git
62+
uv add bolt-api-sdk
7263
```
7364

7465
### PIP
7566

7667
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
7768

7869
```bash
79-
pip install git+<UNSET>.git
70+
pip install bolt-api-sdk
8071
```
8172

8273
### Poetry
8374

8475
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
8576

8677
```bash
87-
poetry add git+<UNSET>.git
78+
poetry add bolt-api-sdk
8879
```
8980

9081
### Shell and script usage with `uv`

pyproject.toml

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

22
[project]
33
name = "bolt-api-sdk"
4-
version = "0.5.5"
4+
version = "0.5.6"
55
description = "Python Client SDK Generated by Speakeasy."
66
authors = [{ name = "Speakeasy" },]
77
readme = "README.md"

src/bolt_api_sdk/_version.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
import importlib.metadata
44

55
__title__: str = "bolt-api-sdk"
6-
__version__: str = "0.5.5"
6+
__version__: str = "0.5.6"
77
__openapi_doc_version__: str = "1.0.1"
88
__gen_version__: str = "2.716.16"
9-
__user_agent__: str = "speakeasy-sdk/python 0.5.5 2.716.16 1.0.1 bolt-api-sdk"
9+
__user_agent__: str = "speakeasy-sdk/python 0.5.6 2.716.16 1.0.1 bolt-api-sdk"
1010

1111
try:
1212
if __package__ is not None:

0 commit comments

Comments
 (0)