Skip to main content

About

urbanairship3 is a Python library for using the Urban Airship web service API for push notifications and rich app pages. This is a fork of original urbanairship with Python 3 support.

Why fork? Primarily for publishing Python 3 compatible version at PyPi for easier install.

Install

pip install urbanairship3

Requirements

As of version 0.6, Python 2.6+ or 3.3+ is required.

Functionality

Version 0.6 is a major upgrade, focusing on support for the new version 3 push API. There has also been a major reorganization of the codebase.

  • device token registration

  • basic push

  • registering and pushing with tags

  • broadcast

  • feedback service

  • device token deactivation (deregistration)

  • device token listing

  • rich push

  • scheduled notifications

Usage

See the full documentation, as well as the Urban Airship API Documentation.

Simple iOS Push

>>> import urbanairship as ua
>>> airship = ua.Airship('application_key','master_secret')
>>> push = airship.create_push()
>>> push.audience = ua.or_(ua.alias('adam'), ua.device_token('some_token'))
>>> push.notification = ua.notification(alert='Hello')
>>> push.device_types = ua.all_
>>> push.send()

Broadcast to iOS, Android, and BlackBerry devices

>>> push = airship.create_push()
>>> push.audience = ua.all_
>>> push.notification = ua.notification(
...     ios=ua.ios(alert='Hello iOS'),
...     android=ua.android(alert='Hello Android'),
...     blackberry=ua.blackberry(alert='Hello BlackBerry'))
>>> push.device_types = ua.device_types('ios', 'android', 'blackberry')
>>> push.send()

Sending a rich app page to a single iOS device

>>> import urbanairship
>>> airship = urbanairship.Airship('application_key','master_secret')
>>> push = airship.create_push()
>>> push.audience = ua.device_token('some_token')
>>> push.notification = ua.notification(alert='Hello')
>>> push.device_types = ua.device_types('ios')
>>> push.message = ua.message(
...     "Hello, Rich Push User",
...     "<html><h1>Hello!</h1><p>Goodbye.</p></html>")
>>> push.send()

Questions

The best place to ask questions is our support site: http://support.urbanairship.com/

History

  • 0.1 Initial release

  • 0.2 Added tags, broadcast, feedback

  • 0.3 Added deregister, device token list, other minor improvements

  • 0.4 Added batch push

  • 0.5 Added Android, Blackberry, Rich Push, and scheduled notifications

  • 0.6 Major refactoring, support for push api v3

Metadata

Release files for urbanairship3 0.6.3

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

Source distribution (sdist)

Source distribution for urbanairship3 0.6.3
File Size Uploaded
urbanairship3-0.6.3.tar.gz 15.4 kB Details

Release files / urbanairship3-0.6.3.tar.gz

Download URL urbanairship3-0.6.3.tar.gz
Size 15.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f7c9206b58159cbb402d91597629ea929c34e70aec48146d1aa39222ce7085c7
BLAKE2b-256 checksum
How to use checksums
34e8d066a8f4a63bfe47745ee53faadf59c527e8927cb115397de365a32e76b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.6.3 This release

1 release file

0.6.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page