usps-api

This is a simple Python wrapper for the USPS API. Instead of having to deal with XML, use this library and receive nicely formatted JSON back while tracking shipments, creating shipments, and validating addresses.

Installation

To install usps-api, use pip:

pip install usps-api

Or to install from source:

python setup.py install

Configuration

Note: In order to use any of these APIs, you need to register with USPS and get a USERID https://www.usps.com/business/web-tools-apis/welcome.htm. For the create_shipment endpoint, you will also need to request further permissions by emailing uspstechnicalsupport@mailps.custhelp.com about Label API access.

Usage

Track Shipments

from usps import USPSApi

usps = USPSApi('XXXXXXXXXXXX')
track = usps.track('00000000000000000000')
print(track.result)

Create Shipment

The create_shipment function needs a to and crom address, weight (in ounces), service type and label type. Service types and lable types can be found in usps/constants.py. Defaults are SERVICE_PRIORITY and LABEL_ZPL.

from usps import USPSApi, Address
from usps import SERVICE_PRIORITY, LABEL_ZPL

to_address = Address(
    name='Tobin Brown',
    address_1='1234 Test Ave.',
    city='Test',
    state='NE',
    zipcode='55555'
)

from_address = Address(
    name='Tobin Brown',
    address_1='1234 Test Ave.',
    city='Test',
    state='NE',
    zipcode='55555'
)
weight = 12  # weight in ounces

usps = USPSApi('XXXXXXXXXXXX', test=True)
label = usps.create_label(to_address, from_address, weight, SERVICE_PRIORITY, LABEL_ZPL)
print(label.result)

Validate Address

from usps import USPSApi, Address

address = Address(
    name='Tobin Brown',
    address_1='1234 Test Ave.',
    city='Test',
    state='NE',
    zipcode='55555'
)
usps = USPSApi('XXXXXXXXXXXX', test=True)
validation = usps.validate_address(address)
print(validation.result)

License

MIT. See LICENSE for more details.

Metadata

Release files for usps-api 0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for usps-api 0.1
File	Size	Uploaded
usps-api-0.1.tar.gz	4.0 kB	Oct 9, 2018	Details

Built distribution (wheel)

Table of built distributions (wheels) for usps-api 0.1
File	Interpreter	ABI	Platform	Reset
usps_api-0.1-py3.5.egg 7.8 kB Oct 9, 2018	Legacy Egg format	-	-	Details

Total release size: 11.8 kB

Release files / usps-api-0.1.tar.gz

Download URL	usps-api-0.1.tar.gz
Size	4.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`799f1149cba98a1e48154afecedcf7497afdcf1bb661476d07a4e1553052c1cf`
BLAKE2b-256 checksum How to use checksums	`a0d3a3c81e0bf70df752526a48a88376e957f98353a9014f549e331adfefef95`
Upload date	Oct 9, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.2`

Release files / usps_api-0.1-py3.5.egg

Download URL	usps_api-0.1-py3.5.egg
Size	7.8 kB
Tags	Egg
SHA-256 checksum How to use checksums	`3048dd8e5dca815201829f619fca1ff3710092bd5e6456ed5f3fb3c9f7eac1f4`
BLAKE2b-256 checksum How to use checksums	`bb8b4c923a638f4abf16a59ca0d8b999f02a7f945055fd9b9099242e8e502dcd`
Upload date	Oct 9, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.2`