33[ ![ fern shield] ( https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen )] ( https://github.com/fern-api/fern )
44[ ![ pypi] ( https://img.shields.io/pypi/v/webflow.svg )] ( https://pypi.python.org/pypi/webflow )
55
6- The Webflow Python Library provides convenient access to the Webflow API from
7- applications written in Python. The library includes type definitions for all
6+ The Webflow Python Library provides convenient access to the [ Webflow Data API] ( https://developers.webflow.com/reference/rest-introduction ) from
7+ applications written in Python.
8+
9+ The library includes type definitions for all
810request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
911
1012## Documentation
1113
12- API reference documentation is available [ here] ( https://developers.webflow.com/reference/designer-api-reference ) .
14+ Explore the API reference documentation [ here] ( https://developers.webflow.com/reference/rest-introduction ) .
1315
1416## Installation
1517
@@ -53,12 +55,12 @@ asyncio.run(main())
5355
5456## OAuth
5557
56- To implement OAuth, you'll need a registred Webflow App.
58+ To implement OAuth, you'll need to [ register a Webflow App in your Workspace ] ( https://developers.webflow.com/reference/authorization )
5759
5860### Step 1: Authorize URL
5961
60- The first step in OAuth is to generate an authorization url . Use this URL
61- to fetch your authorization code . See the [ docs] ( https://docs.developers.webflow.com/v1.0.0/docs/oauth#user-authorization )
62+ The first step in OAuth is to generate an Authorization URL . Use this URL
63+ to fetch your Authorization Code . See the [ docs] ( https://docs.developers.webflow.com/v1.0.0/docs/oauth#user-authorization )
6264for more details.
6365
6466``` python
@@ -90,7 +92,7 @@ access_token = get_access_token(
9092```
9193
9294### Step 3: Instantiate the client
93- Instantiate the client using your access_token.
95+ Instantiate the client using your ` access_token ` .
9496
9597``` python
9698from webflow.client import Webflow
@@ -101,13 +103,13 @@ client = Webflow(
101103```
102104
103105## Webflow Module
104- All of the models are nested within the Webflow module. Let Intellisense
106+ All of the models are nested within the Webflow module. Let IntelliSense
105107guide you!
106108
107109![ Alt text] ( assets/module.png )
108110
109111## Exception Handling
110- All errors thrown by the SDK will be sublcasses of [ ` ApiError ` ] ( ./src/webflow/core/api_error.py ) .
112+ All errors thrown by the SDK will be subclasses of [ ` ApiError ` ] ( ./src/webflow/core/api_error.py ) .
111113
112114``` python
113115import webflow
@@ -138,7 +140,7 @@ client = Webflow(
138140```
139141
140142### Custom HTTP client
141- You can override the httpx client to customize it for your use case. Some common use-cases
143+ You can override the httpx client to customize it for your use- case. Some common use-cases
142144include support for proxies and transports.
143145
144146``` python
@@ -156,9 +158,10 @@ client = Webflow(
156158
157159## Beta Status
158160
159- This SDK is in beta, and there may be breaking changes between versions without a major
160- version update. Therefore, we recommend pinning the package version to a specific version.
161- This way, you can install the same version each time without breaking changes.
161+ This SDK is in ** Preview** , and there may be breaking changes between versions without a major
162+ version update.
163+
164+ To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.
162165
163166## Contributing
164167
0 commit comments