Skip to content

Commit 797bdc4

Browse files
committed
chore: prepare v9.0.0 for release
1 parent 3f395a1 commit 797bdc4

File tree

4 files changed

+47
-14
lines changed

4 files changed

+47
-14
lines changed

CHANGELOG.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# CHANGELOG
22

3-
## Next major release
3+
## v9.0.0 (2023-12-06)
44

5-
- Removes `withCarbonOffset` parameter from `create`, `buy`, and `regenerateRates` functions of the Shipment service as EasyPost now offers Carbon Neutral shipments by default for free
6-
- Removes the undocumented `createAndBuy` function from the `Batch` service. The proper usage is to create a batch first and buy it separately
5+
See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-8x-to-90) for more details.
6+
7+
- Removes `with_carbon_offset` parameter from `create`, `buy`, and `regenerate_rates` functions of the Shipment service as EasyPost now offers Carbon Neutral shipments by default for free
8+
- Removes the undocumented `create_and_buy` function from the `Batch` service. The proper usage is to create a batch first and buy it separately
79
- Removes the `beta_carrier_metadata` service as it is deprecated, please use the `carrier_metadata` GA service instead
810

911
## v8.2.1 (2023-10-30)

UPGRADE_GUIDE.md

+40-9
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,43 @@
22

33
Use the following guide to assist in the upgrade process of the `easypost-python` library between major versions.
44

5+
- [Upgrading from 8.x to 9.0](#upgrading-from-8x-to-90)
56
- [Upgrading from 7.x to 8.0](#upgrading-from-7x-to-80)
67
- [Upgrading from 6.x to 7.0](#upgrading-from-6x-to-70)
78
- [Upgrading from 5.x to 6.0](#upgrading-from-5x-to-60)
89

10+
## Upgrading from 8.x to 9.0
11+
12+
### 9.0 High Impact Changes
13+
14+
- [Carbon Offset Removed](#90-carbon-offset-removed)
15+
16+
### 9.0 Low Impact Changes
17+
18+
- [Create and Buy Batch Function Removed](#90-create-and-buy-batch-function-removed)
19+
20+
### 9.0 Carbon Offset Removed
21+
22+
*Likelihood of Impact: **High***
23+
24+
EasyPost now offers Carbon Neutral shipments by default for free! Because of this, there is no longer a need to specify if you want to offset the carbon footprint of a shipment.
25+
26+
The `with_carbon_offset` parameter of the `create`, `buy`, and `regenerate_rates` shipment functions has been removed.
27+
28+
This is a high-impact change for those using `EndShippers`, as the signature for the `create` and `buy` shipment functions have changed. You will need to inspect these callsites to ensure that the EndShipper parameter is being passed in the correct place.
29+
30+
### 9.0 Create and Buy Batch Function Removed
31+
32+
*Likelihood of Impact: **Low***
33+
34+
The `create_and_buy` batch endpoint has been deprecated, and the `create_and_buy` Batch service function has been removed.
35+
36+
The correct procedure is to first create a batch and then purchase it with two separate API calls.
37+
938
## Upgrading from 7.x to 8.0
1039

40+
**NOTICE:** v8 is deprecated.
41+
1142
### 8.0 High Impact Changes
1243

1344
- [Updated Dependencies](#80-updated-dependencies)
@@ -23,7 +54,7 @@ Use the following guide to assist in the upgrade process of the `easypost-python
2354
- [Beta Namespace Changed](#80-beta-namespace-changed)
2455
- [Changed Function Parameter Order and Return Types](#80-changed-function-parameter-order-and-return-types)
2556

26-
## 8.0 Updated Dependencies
57+
### 8.0 Updated Dependencies
2758

2859
Likelihood of Impact: High
2960

@@ -35,7 +66,7 @@ easypost-python now requires Python 3.7 or greater.
3566

3667
All dependencies had minor version bumps.
3768

38-
## 8.0 EasyPostClient
69+
### 8.0 EasyPostClient
3970

4071
Likelihood of Impact: High
4172

@@ -110,13 +141,13 @@ Occurances of `scanform` are now `scan_form` and `Scanform` are now `ScanForm` t
110141

111142
The `primary_or_secondary` parameter name for billing functions is now called `priority` to match the documentation and API.
112143

113-
## 8.0 Beta Namespace Changed
144+
### 8.0 Beta Namespace Changed
114145

115146
Likelihood of Impact: Low
116147

117148
Previously, the beta namespace was found at `easypost.beta.x` where `x` is the name of your model. Now, the beta namespace is simply prepended to the name of your service: `client.beta_x`. for instance, you can call `client.beta_referral_customer.add_payment_method()`.
118149

119-
## 8.0 Changed Function Parameter Order and Return Types
150+
### 8.0 Changed Function Parameter Order and Return Types
120151

121152
Likelihood of Impact: Low
122153

@@ -137,7 +168,7 @@ Functions that previously returned `True` now do not return anything as there is
137168

138169
- [Removal of `get_rates()` Shipment Method](#70-removal-of-getrates-shipment-method)
139170

140-
## 7.0 Updating Dependencies
171+
### 7.0 Updating Dependencies
141172

142173
Likelihood of Impact: High
143174

@@ -149,7 +180,7 @@ easypost-python now requires Python 3.6 or greater and has dropped support for P
149180

150181
All dependencies had minor version bumps.
151182

152-
## 7.0 `shipment.lowest_rate()` Now Expects a List
183+
### 7.0 `shipment.lowest_rate()` Now Expects a List
153184

154185
Previously the `shipment.lowest_rate()` function expected a comma separated string list of filter criteria (carriers and services). These params have been corrected to expect an actual list object.
155186

@@ -161,7 +192,7 @@ shipment.lowest_rate(carriers="USPS,FedEx", services="...")
161192
shipment.lowest_rate(carriers=["USPS", "FedEx"], services=["..."])
162193
```
163194

164-
## 7.0 Removal of `get_rates()` Shipment Method
195+
### 7.0 Removal of `get_rates()` Shipment Method
165196

166197
Likelihood of Impact: Medium
167198

@@ -176,15 +207,15 @@ The HTTP method used for the `get_rates` endpoint at the API level has changed f
176207
- [Updating Dependencies](#60-updating-dependencies)
177208
- [JSON Encoded Bodies](#60-json-encoded-bodies)
178209

179-
## 6.0 Updating Dependencies
210+
### 6.0 Updating Dependencies
180211

181212
Likelihood of Impact: High
182213

183214
**Dependencies**
184215

185216
Bumps the `requests` library from v1 to v2.
186217

187-
## 6.0 JSON Encoded Bodies
218+
### 6.0 JSON Encoded Bodies
188219

189220
Likelihood of Impact: High
190221

easypost/constant.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# flake8: noqa
22
# Library version
3-
VERSION = "8.2.1"
3+
VERSION = "9.0.0"
44
VERSION_INFO = [str(number) for number in VERSION.split(".")]
55

66
# Client defaults

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
setup(
3434
name="easypost",
35-
version="8.2.1",
35+
version="9.0.0",
3636
description="EasyPost Shipping API Client Library for Python",
3737
author="EasyPost",
3838
author_email="[email protected]",

0 commit comments

Comments
 (0)