lob 4.2.0

Lob Python Bindings

lob-python

This is the python wrapper for the Lob.com API. See full Lob.com documentation here. For best results, be sure that you're using the latest version of the Lob API and the latest version of the python wrapper.

This library supports active Python releases (i.e., versions which have not reached their end of life), as well as PyPy 3. The currently supported versions include:

• Python 3.6
• Python 3.7
• Python 3.8
• Python 3.9
• PyPy 3

Table of Contents

• Getting Started
  • Registration
  • Installation
  • Usage
• Examples
• API Documentation
• Testing

Getting Started

Lob Python wrapper works in the object oriented style. That is, to make calls you have to call the method on a class and the return types are python objects. To get a dict on any object, you can call the to_dict() method of the object.

Here's a general overview of the Lob services available, click through to read more.

• Postcards API
• Letters API
• Checks API
• Address Verification API

Please read through the official API Documentation to get a complete sense of what to expect from each endpoint.

Registration

First, you will need to first create an account at Lob.com and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the Settings Panel.

Installation

You can use pip to install the package.

pip install lob

To initialize the wrapper, import lob and set the api_key

import lob
lob.api_key = 'your-api-key'

// set an api version (optional)
lob.api_version = 'api-version'

Usage

We've provided an example script you can run in examples/ that has examples of how to use the lob-python wrapper with some of our core endpoints.

Examples

We've provided various examples for you to try out here.

There are simple scripts to demonstrate how to create all the core Lob objects (checks, letters, postcards. etc.) as well as more complex examples that utilize other libraries and external files.

API Documentation

• Introduction
• Versioning
• Errors
• Rate Limiting
• Webhooks
• Cancellation Windows
• Scheduled Mailings
• Metadata
• HTML Templates
• Asset URLs
• Addresses
  • Address Book
    • The Address Object
    • Create an Address
    • Retrieve an Address
    • Delete an Address
    • List all Addresses
• US Verification API
  • US Verification API
    • The US Verification Object
    • Verify a US Address
    • Bulk Verify US Addresses
    • The US ZIP Lookup Object
    • Lookup a US ZIP Code
  • US Autocompletion API
    • The US Autocompletion Object
    • Autocomplete a US Address
    • The US Autocompletion Test Environment
• Int'l Verification API
  • International Verifications
    • Verify an International Address
    • Bulk Verify International Addresses
• Postcards API
  • Postcards
    • The Postcard Object
    • Create a Postcard
    • Retrieve a Postcard
    • Cancel a Postcard
    • List all Postcards
• Self Mailers API
  • Self Mailers
    • The Self Mailer Object
    • Create a Self Mailer
    • Retrieve a Self Mailer
    • Cancel a Self Mailer
    • List all Self Mailers
• Letters API
  • Letters
    • The Letter Object
    • Create a Letter
    • Retrieve a Letter
    • Cancel a Letter
    • List all Letters
• Checks API
  • Checks
    • The Check Object
    • Create a Check
    • Retrieve a Check
    • Cancel a Check
    • List all Checks
  • Bank Accounts
    • The Bank Account Object
    • Create a Bank Account
    • Retrieve a Bank Account
    • Delete a Bank Account
    • Verify a Bank Account
    • List all Bank Accounts
• Appendix
  • API Changelog
  • The Tracking Event Object
  • Events
  • HTML Examples
  • Image Prepping
  • US Verification Details

Testing

lob-python uses Pipenv to manage development environments and dependencies.

You install all the development requirements by running

$ pipenv install --dev
$ pipenv shell

You can run all tests with the command LOB_API_KEY=YOUR_TEST_API_KEY nosetests in the main directory.

$ LOB_API_KEY=YOUR_TEST_API_KEY nosetests

Making Releases

lob-python includes bumpversion as a development dependency. This tool should be used when changing the version number, as it will ensure that it's updated correctly and consistently.

Running bumpversion will increment the specified version part (major, minor, patch), commit the change, and tag it.

$ bumpversion <part>

After the version has been bumped, you can push the change and tag.

$ git push origin head
$ git push origin --tags

Finally, create the distribution and push it to PyPI using twine.

$ python setup.py sdist
...
Writing lob-4.0.0/setup.cfg
Creating tar archive
removing 'lob-4.0.0' (and everything under it)
$ twine upload dist/lob-4.0.0.tar.gz

---

Copyright © 2013-2019 Lob.com

Released under the MIT License, which can be found in the repository in LICENSE.txt.