Skip to content

Commit 312c20f

Browse files
authored
[TOOLSLIBS-2187] Docs refine v7 (#217)
* docs fix * typo * couple more example updates * readme fix
1 parent 5b90e3c commit 312c20f

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
``urbanairship`` is a Python library for using the `Airship
2-
<http://airship.com/>`_ REST API for push notifications, message
1+
``urbanairship`` is a Python library for using the Airship REST
2+
API for push notifications, message
33
center messages, email, and SMS.
44

55
Requirements
66
============
77

8-
Python 3.6 or higher is required. Other requirements can be found in requirements.txt.
8+
Python 3.10 or higher is required. Other requirements can be found in requirements.txt.
99

1010
Questions
1111
=========

docs/client.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ Example usage:
2424
.. code-block:: python
2525
2626
import urbanairship as ua
27-
airship = ua.client.BasicAuthClient('<app key>', '<master secret>')
27+
client = ua.client.BasicAuthClient('<app key>', '<master secret>')
2828
2929
# Create and send a push notification
30-
push = airship.create_push()
30+
push = ua.Push(client)
3131
push.audience = ua.all_
3232
push.notification = ua.notification(alert='Hello, world!')
3333
push.device_types = ua.device_types('ios', 'android')
@@ -47,10 +47,10 @@ Example usage:
4747
.. code-block:: python
4848
4949
import urbanairship as ua
50-
airship = ua.client.BearerTokenClient('<app key>', '<bearer token>')
50+
client = ua.client.BearerTokenClient('<app key>', '<bearer token>')
5151
5252
# Create and send a push notification
53-
push = airship.create_push()
53+
push = ua.Push(client)
5454
push.audience = ua.all_
5555
push.notification = ua.notification(alert='Hello, world!')
5656
push.device_types = ua.device_types('ios', 'android')
@@ -72,15 +72,15 @@ Example usage:
7272
import urbanairship as ua
7373
7474
# Initialize with OAuth credentials
75-
airship = ua.client.OAuthClient(
75+
client = ua.client.OAuthClient(
7676
key='<app key>',
7777
client_id='<client id>',
7878
private_key='<private key>',
7979
scope=['push:write', 'channels:read'] # Optional scopes
8080
)
8181
8282
# Create and send a push notification
83-
push = airship.create_push()
83+
push = ua.Push(client)
8484
push.audience = ua.all_
8585
push.notification = ua.notification(alert='Hello, world!')
8686
push.device_types = ua.device_types('ios', 'android')

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ representing a single Airship project.
2222
.. code-block:: python
2323
2424
import urbanairship as ua
25-
airship = ua.client.BasicAuthClient('<app key>', '<master secret>')
25+
client = ua.client.BasicAuthClient('<app key>', '<master secret>')
2626
27-
push = airship.create_push()
27+
push = ua.Push(client)
2828
push.audience = ua.all_
2929
push.notification = ua.notification(alert='Hello, world!')
3030
push.device_types = ua.device_types('ios', 'android')

docs/push.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ to a specific device type which can be a list of types:
1818
.. code-block:: python
1919
2020
import urbanairship as ua
21-
airship = ua.client.BasicAuthClient(app_key, master_secret)
21+
client = ua.client.BasicAuthClient(app_key, master_secret)
2222
23-
push = airship.create_push()
23+
push = ua.Push(client)
2424
push.audience = ua.all_
2525
push.notification = ua.notification(alert='Hello, world!')
2626
push.device_types = ua.device_types('android', 'ios')

0 commit comments

Comments
 (0)