EasyPost Python Client Library
EasyPost is the simple shipping API. You can sign up for an account at https://easypost.com.
Requirements
- Python 2.7 or 3.3+ (or corresponding PyPy versions). Note that we only test on Python 2.7 and 3.5+; we strongly recommend against using 3.3.x or 3.4.x as they are no longer supported by many libraries.
- requests >= v2.4.3 (if not on Google App Engine) (will be installed automatically)
- six (will be installed automatically)
Looking for a client library for another language? Check out https://www.easypost.com/docs/libraries.
Installation
You can install easypost via pip with:
pip install easypost
Alternatively, you can clone the EasyPost python client repository:
git clone https://github.com/EasyPost/easypost-python
Install:
python setup.py install
Import the EasyPost client:
import easypost
Example
import easypost
easypost.api_key = '<YOUR API KEY FROM https://www.easypost.com/account/api-keys>'
# create and verify addresses
to_address = easypost.Address.create(
verify=["delivery"],
name = "Dr. Steve Brule",
street1 = "179 N Harbor Dr",
street2 = "",
city = "Redondo Beach",
state = "CA",
zip = "90277",
country = "US",
phone = "310-808-5243"
)
from_address = easypost.Address.create(
verify=["delivery"],
name = "EasyPost",
street1 = "118 2nd Street",
street2 = "4th Floor",
city = "San Francisco",
state = "CA",
zip = "94105",
country = "US",
phone = "415-456-7890"
)
# create parcel
try:
parcel = easypost.Parcel.create(
predefined_package = "Parcel",
weight = 21.2
)
except easypost.Error as e:
print(str(e))
if e.param is not None:
print('Specifically an invalid param: %r' % e.param)
parcel = easypost.Parcel.create(
length = 10.2,
width = 7.8,
height = 4.3,
weight = 21.2
)
# create customs_info form for intl shipping
customs_item = easypost.CustomsItem.create(
description = "EasyPost t-shirts",
hs_tariff_number = 123456,
origin_country = "US",
quantity = 2,
value = 96.27,
weight = 21.1
)
customs_info = easypost.CustomsInfo.create(
customs_certify = 1,
customs_signer = "Hector Hammerfall",
contents_type = "gift",
contents_explanation = "",
eel_pfc = "NOEEI 30.37(a)",
non_delivery_option = "return",
restriction_type = "none",
restriction_comments = "",
customs_items = [customs_item]
)
# create shipment
shipment = easypost.Shipment.create(
to_address = to_address,
from_address = from_address,
parcel = parcel,
customs_info = customs_info
)
# buy postage label with one of the rate objects
shipment.buy(rate = shipment.rates[0])
# alternatively: shipment.buy(rate = shipment.lowest_rate())
print(shipment.tracking_code)
print(shipment.postage_label.label_url)
# Insure the shipment for the value
shipment.insure(amount=100)
print(shipment.insurance)
Documentation
Up-to-date documentation is available at: https://www.easypost.com/docs
Client Library Development
Releasing
- Add new features to CHANGELOG.md
- Bump the version in
easypost/version.py - Bump the version in
setup.py - Create and push a signed git tag
- Create a Release in Github based on the tag, with a human-readable summary of changes
- Build sdist and wheel:
rm -rf build/ dist/ ./*.egg-info; python3 setup.py sdist bdist_wheel - Push to PyPI with
twine upload dist/*
Running Tests
To run tests:
- Create a virtualenv for your version of Python (e.g.,
python2.7 -m virtualenv venv) - Install dependencies in that virtualenv (
./venv/bin/pip install requests six) - Install test dependencies (
./venv/bin/pip install -r requirements-tests.txt) - Export
$TEST_API_KEYand$PROD_API_KEYappropriately (these are set automatically for CI) - Run the tests with
py.test(./venv/bin/py.test -vs tests)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
easypost-6.0.0.tar.gz
(14.8 kB
view details)
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
easypost-6.0.0-py3-none-any.whl
(10.2 kB
view details)
File details
Details for the file easypost-6.0.0.tar.gz.
File metadata
- Download URL: easypost-6.0.0.tar.gz
- Upload date:
- Size: 14.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
638bb5554195ba2997254678f9fda677614a792302e6fa7563f06cd088ee8beb
|
|
| MD5 |
3ad137d93f2ec406a5f6a0db266cac64
|
|
| BLAKE2b-256 |
659be3586df8909b3c64c272ef0925c4c7fec0ce251a8ad8d08387d75397c885
|
File details
Details for the file easypost-6.0.0-py3-none-any.whl.
File metadata
- Download URL: easypost-6.0.0-py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6988ba09470bfd6f9c484e80993504d9034f643ca509103194ba1ec1a25f2072
|
|
| MD5 |
a3729b4f3295143179a58992f0129dca
|
|
| BLAKE2b-256 |
aed14b14452ca2664b865fd789dcab65b270d56715798f0c73f0bb37ae07ee5e
|
File details
Details for the file easypost-6.0.0-py2-none-any.whl.
File metadata
- Download URL: easypost-6.0.0-py2-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
34be12aa931d2a0d24cb46cbf4b83044999fb957a887e778ab2b4e4378121f76
|
|
| MD5 |
512f8874d2877c0719f17b390efe62ae
|
|
| BLAKE2b-256 |
904c612053cc023af408e2dac52bec17c7154459e2faf9dc6196d927937418bd
|
