8000 Rename beta SDKs to public preview SDKs in readme (#1515) · stripe/stripe-python@7db7345 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7db7345

Browse files
authored
Rename beta SDKs to public preview SDKs in readme (#1515)
* Rename beta SDKs to public preview SDKs in readme * Update README.md
1 parent 0e025eb commit 7db7345

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -246,22 +246,21 @@ sends by default. If you are overriding `stripe.api_version` / `stripe_version`
246246
[webhook endpoint](https://stripe.com/docs/webhooks#api-versions) tied to an older version,
247247
be aware that the data you see at runtime may not match the types.
248248

249-
## Beta SDKs
249+
### Public Preview SDKs
250250

251-
Stripe has features in the beta phase that can be accessed via the beta version of this package.
252-
We would love for you to try these and share feedback with us before these features reach the stable phase.
253-
To install a beta version use `pip install` with the exact version you'd like to use:
251+
Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `-beta.X` suffix like `12.2.0-beta.2`.
252+
We would love for you to try these as we incrementally release new features and improve them based on your feedback.
253+
254+
The public preview SDKs are different versions of the same package as the stable SDKs. They are appended with `b.X` such as `10.1.0b1`. To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-dotnet/releases/) and then use it in the `pip install` command:
254255

255256
```
256-
pip install --pre stripe
257+
pip install stripe==<replace-with-the-version-of-your-choice>
257258
```
258259

259260
> **Note**
260-
> There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your [requirements file](https://pip.pypa.io/en/stable/user_guide/#requirements-files) or `setup.py`. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.
261-
262-
We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version.
261+
> There can be breaking changes between two versions of the public preview SDKs without a bump in the major version. Therefore we recommend pinning the package version to a specific version in your [requirements file](https://pip.pypa.io/en/stable/user_guide/#requirements-files) or `setup.py`. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest public preview SDK.
263262

264-
If your beta feature requires a `Stripe-Version` header to be sent, set the `stripe.api_version` field using the `stripe.add_beta_version` function:
263+
Some preview features require a name and version to be set in the `Stripe-Version` header like `feature_beta=v3`. If your preview feature has this requirement, use the `stripe.add_beta_version` function (available only in the public preview SDKs):
265264

266265
```python
267266
stripe.add_beta_version("feature_beta", "v3")

0 commit comments

Comments
 (0)
0