gotify 0.2.1

Access your gotify server.

python-gotify

This python module allows to manage and send messages to your gotify server without handling requests manually.

Installation

python-gotify can be installed from PyPi using pip:

pip install gotify

Usage

To send messages:

import gotify

gotify_obj = gotify.gotify(
    base_url="https://gotify.example.com",
    app_token="AsWIJhvlHb.xgKe",
)

gotify_obj.create_message(
    "Hello you wonderful people!",
    title="Hello World",
    priority=0,
)

Note: To send messages you need to create a new application and set app_token accordingly.

You can also manage things like applications:

import gotify

gotify_obj = gotify.gotify(
    base_url="https://gotify.example.com",
    client_token="CoLwHBCAr8z2MMA",
)

app = gotify_obj.create_application("foobar", description="test application")

print("Created new application:", app)

would result in

Created new application: {'id': 42, 'token': 'ArHD_yGYf63-A13', 'name': 'fooba
r', 'description': 'test application', 'internal': False, 'image': 'static/def
aultapp.png'}

Note: For most things you need to create a new client and set client_token accordingly.

This module tries to implement every endpoint of the gotify API as an instance method of the gotify class. If you use only one gotify instance, you can use the module-level functions instead, which then use an internal gotify object.

More details about the capabilities of gotify's API can be found in its API documentation.

Note: since I don't use any gotify plugins, plugin-related functions are completely untested.