Skip to main content

Comprehensive bindings and command line utility for the Pushsafer.com notification service

Project description

Pushsafer.com

python-pushsafer aims at providing comprehensive Python bindings for the API of the Pushsafer Notification Service as documented here.

Forked from and original created by: [Thibauth](https://github.com/Thibauth/python-pushover)

Installation

You can install it directly from GitHub:

git clone https://github.com/appzer/python-pushsafer.git
cd python-pushsafer
pip install .

Overview

After being imported, the module must be initialized by calling the init function with a valid private key. Thus, a typical use of the pushsafer module looks like this:

from pushsafer import init, Client

init("<privatekey>")
Client("").send_message("Hello!", title="Hello", icon="1", sound="4", vibration="2", device="323")

You can also pass the privatekey optional argument to Client to initialize the module at the same time:

from pushsafer import Client

client = Client("", privatekey="<privatekey>")
client.send_message("Hello!", title="Hello", icon="1", sound="4", vibration="2", device="323")

Command line

python-pushsafer also comes with a command line utility pushsafer that you can use as follows:

pushsafer --privatekey <privatekey> "Hello!"

Use pushsafer --help to see the list of available options.

Configuration

Both the pushsafer module and the pushsafer command line utility support reading arguments from a configuration file.

The most basic configuration file looks like this:

[Default]
privatekey=aaaaaa

You can have additional sections and specify a device as well:

[my-iPhone]
privatekey=bbbbbb
device=233

python-pushsafer will attempt to read the configuration from ~/.pushsaferrc by default. The section to read can be specified by using the profile argument. With the configuration file above, you can send a message by simply doing:

from pushsafer import Client

Client().send_message("Hello!", title="Hello", icon="1", sound="4", vibration="2", device="323")

or pushsafer --title "Hello" "Hello!" from the command line.

API

You can access the full API documentation here.

Contributors

Changes

0.1 (2016-09-13)

Initial Release

Project details


Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page