Welcome to pushover_complete

pushover_complete is 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: 3.9, 3.10, 3.11, 3.12, 3.13

Development

Development Build Status

Development Test Coverage Status

Development Documentation Status

Development Supported Python Versions: 3.9, 3.10, 3.11, 3.12, 3.13

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 API Reference to see how.

On this page:

Installation

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

$ pip install pushover_complete

The source code for this project is hosted on Github. Downloading and installing from source goes like this:

$ git clone https://github.com/scolby33/pushover_complete
$ cd pushover_complete
$ pip install .

If you intend to install in a virtual environment, activate it before running pip install.

pushover_complete currently supports Python 3.9, 3.10, 3.11, 3.12, and 3.13. This package only supports the currently-supported versions of Python.

See Installation for further information about installing pushover_complete in all manner of ways.

Roadmap

pushover_complete emerged from my frustrating experience with a number of only partially-complete Pushover packages. It is my goal to fully support all of Pushover’s API endpoints in this package, beginning with the most essential ones and working from there. The current status of progress towards this goal is tracked in the roadmap.

API Reference

Information about each function, class, and method is included here.

Contributing

pushover_complete is an open-source project and, so far, is mostly a one-person effort. Any contributions are welcome, be they bug reports, pull requests, or otherwise. Issues are tracked on Github.

Check out Contributing for more information on getting involved.

License Information

pushover_complete is licensed under the MIT License, a permissive open-source license.

The full text of the license is available here and in the root of the source code repository.

Note

This package is not written by or associated with Superblock, the creators of Pushover. The use of the name “Pushover” in the package name is authorized per Superblock’s attribution rules. See the logos section of the Pushover website for more information.

Changelog

pushover_complete adheres to the Semantic Versioning (“Semver”) 2.0.0 versioning standard. Details about this versioning scheme can be found on the Semver website. Versions postfixed with ‘-dev’ are currently under development and those without a postfix are stable releases.

You are reading the documents for version 2.0.0 of pushover_complete.

Full changelogs can be found on the Changelog page.

Indices and tables