/pushover_complete

A Python package for interacting with *all* aspects of the Pushover API.

Primary LanguagePythonMIT LicenseMIT

pushover_complete

A Python package for interacting with all aspects of the Pushover API.

Stable Stable Build Status Stable Test Coverage Status Stable Documentation Status Stable Supported Python Versions: 2.7, 3.5, and 3.6
Development Development Build Status Development Test Coverage Status Development Documentation Status Development Supported Python Versions: 2.7, 3.5, 3.6, and 3.7

To learn more about Pushover and the Pushover API, please visit the Pushover Website, https://pushover.net.

>>> from pushover_complete import PushoverAPI
>>> p = PushoverAPI('azGDORePK8gMaC0QOYAMyEEuzJnyUi')  # an instance of the PushoverAPI representing your application
>>> p.send_message('uQiRzpo4DXghDmr9QzzfQu27cmVRsG', 'Your toast is finished.')  # send a message to a user

That's all you need to get started with sending Pushover notifications from your Python program. The majority of Pushover's API endpoints are accessible via pushover_complete. Check out the docs to learn more.

Installation

Installation should be as easy as executing this command in your chosen terminal:

$ pip install pushover_complete

pushover_complete officially supports Python 2.7, 3.5, 3.6, and 3.7. Currently, Python 3.4 passes all test and functions properly as well, but this could change: this version is not officially targeted by development. Tox has dropped support for Python 3.3 and, as such, tests are no longer run on this version. Like for Python 3.4, functionality could break for Python 3.3 at any time. Additionally, due to changes in Sphinx, the documentation cannot be built with Python 3.3.

As of version 1.1.0, support for Python 3.5 is deprecated. It will be removed in the next major version release. This doesn't mean that Python 3.5 will stop working immediately, but I will no longer consider failing tests for that version to be critical.

Support for Python 2.x may be dropped in the future, but only in a major version update (e.g. 1.x.y → 2.x.y) and this change will be announced well in advance.

Contributing

Contributions, large or small, from bug reports to pull requests and full-on forks, are highly encouraged. Read the the contributing page in the docs or CONTRIBUTING.rst for more information on getting involved.

The full list of contributors is in AUTHORS.rst or on GitHub.

Changelog

Changes as of 6 April 2018

1.1.1 <6 April 2018>

  • HOTFIX for 1.1.0
  • Fix Python versions badge in the documents index
  • Add the Python 3.6 classifier in setup.py so the right versions are shown on PyPI

1.1.0 <6 April 2018>

  • Add image attachment support (Pulls #5 and #9)
  • Officially add support for Python 3.6
  • Change default tox environment for Python 3 to py36
  • Refactored .travis.yml to be more concise and use the new py environment specification (Pull #8)
  • Some refactoring in the main API (more list comprehensions yay!) (Pull #6)
  • Several small documentation changes/refinements

1.0.2 <23 December 2016>

  • "Add" Python 3.6 support. It's not in Travis as an allowed failure and didn't require any code changes to pass!
  • Fix a major bug with the receipt cancel API. I was using a GET request instead of a POST
  • Stop using the releases Sphinx plugin for the changelog. Its philosophy didn't match well with mine
  • Update release procedure based on no longer using releases
  • Some minor documentation fixes

1.0.1 <10 May 2016>

  • Officially add Python 2.7 support and add testing for it to tox and Travis
  • Numerous updates to documentation and README, etc. to make them prettier and more useful

1.0.0 <9 May 2016>

  • Implementation of methods for the Pushover messages, sounds, users, receipt, subscriptions, groups, and licenses APIs
  • Documentation and build process

License

MIT. See the LICENSE.rst file for more information.