Metadata-Version: 2.0
Name: pushjet
Version: 1.0.0
Summary: A Python API for Pushjet. Send notifications to your phone from Python scripts!
Home-page: https://github.com/obskyr/pushjet-py
Author: Samuel Messner
Author-email: powpowd@gmail.com
License: MIT
Download-URL: https://github.com/obskyr/pushjet-py/tarball/v1.0.0
Keywords: pushjet notifications android phone api rest
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Dist: decorator (>=4.0.6,<5.0.0)
Requires-Dist: requests (>=2.11.1,<3.0.0)

pushjet |logo| (Python API)
=============================

.. |logo| image:: http://i.imgur.com/DayiPBl.png
    :align: middle

Welcome to ``pushjet``, Python's `Pushjet <https://pushjet.io/>`__ (`see on GitHub <https://github.com/Pushjet/Pushjet-Server-Api>`__) API. Pushjet lets you push notifications directly to your phone (among other things)! This module lets you do that pushing from Python! It's pretty sweet - it lets you do all sorts of cool things, like integrating notifications into your web app or notifying you when something goes on sale.

And yep, the module's just named ``pushjet``. Spiffy name, and surely not at all confusing. Probably. Hopefully. Maybe.

How to install
--------------

The module is `on GitHub <https://github.com/obskyr/pushjet-py>`__, and `it's also on PyPI <https://pypi.python.org/pypi/pushjet>`__! That means you can install it using `pip <https://pip.pypa.io/en/latest/installing/>`__. Simply run the following to install it:

.. code:: bash

    pip install pushjet

Bam, you're ready to go. It's compatible with both Python 2 and 3, too - nice, huh?

How to use
----------

See the *Getting started* section of the `documentation <http://pushjet.readthedocs.io/>`__. Here's a little taste:

.. code:: python

    import pushjet
    import uuid

    service = pushjet.Service.create(
        "Housing",
        "http://example.com/house_icon.png"
    )
    device = pushjet.Device(uuid.uuid4())
    device.subscribe(service)
    service.send(
        "A spot is open for you in the competitive eating course!", # Message
        "Course open", # Title
        "http://example.com/courses/eating/competitive" # Link
    )
    for message in device.get_messages():
        print message.title
        print message.message

For information on all the properties of the classes, and on how to use custom API instances, once again see the `documentation <http://pushjet.readthedocs.io/>`__.

Contact
=======

If there's a feature you're missing or a bug you've found in ``pushjet``, `open an issue on GitHub <https://github.com/obskyr/pushjet-py/issues/new>`__. If you've got a question - or there's anything you'd like to talk about at all, really - you can reach me via:

* `Twitter (@obskyr) <https://twitter.com/obskyr>`__
* `E-mail <mailto:powpowd@gmail.com>`__

I usually answer much faster on Twitter. Thaaaat... should be all. I think. Unless I've forgotten something, which I don't think I have. I never *think* I have, though, and then sometimes I still have. Let's hope I haven't this time.

Enjoy!


