Airship Python Library

Python library for using Airship’s messaging platform and related features.

Resources

Versions

For prior versions, see our Release history.

Installation

Using pip:

$ pip install urbanairship

Using the library

The library is intended to be used with the small footprint of a single import. To get started, import the package, and create an Airship object representing a single Airship application.

import urbanairship as ua
airship = ua.Airship('<app key>', '<master secret>')

push = airship.create_push()
push.audience = ua.ios_channel('074e84a2-9ed9-4eee-9ca4-cc597bfdbef3')
push.notification = ua.notification(ios=ua.ios(alert='Hello from Python', badge=1))
push.device_types = ua.device_types('ios')
push.send()

The library uses Requests for communication with the Airship API, providing connection pooling and strict SSL checking. The Airship object is threadsafe, and can be instantiated once and reused in multiple threads.

Logging

urbanairship uses the standard logging module for integration into an application’s existing logging. If you do not have logging configured otherwise, your application can set it up like so:

import logging
logging.basicConfig()

If you’re having trouble with the Airship API, you can turn on verbose debug logging.

logging.getLogger('urbanairship').setLevel(logging.DEBUG)

As of Python 2.7, DeprecationWarning warnings are silenced by default. To enable them, use the warnings module:

import warnings
warnings.simplefilter('default')