Skip to main content

A simple Python wrapper for Gotify

Project description

Gotipy

A simple Python wrapper for Gotify

Requirements

Installation

pip install gotipy

Usage

from gotipy import Gotify

g = Gotify(host_address='https://yourdomain.com')

Create a new application

g.create_app(admin_username='admin',
             admin_password='admin',
             app_name='demo',
             desc='My first app!')
# {
#     'id': 1,
#     'token': 'xxxxxxxxxx',
#     'name': 'demo',
#     'description': 'My first app!',
#     'internal': False,
#     'image': 'static/defaultapp.png'
# }

Push messages to an application

g.push(title='My message',
       message='Hello, World!',
       priority=9,
       token='xxxxxxxxxx')
# {
#     'id': 1,
#     'appid': 1,
#     'message': 'Hello, World!',
#     'title': 'My message',
#     'priority': 9,
#     'date': '2022-05-16T05:25:29.367216435Z'
# }

Notes:

  • You can set GOTIFY_HOST_ADDRESS as an envionmnt variable instead of passing host_address to the class instance.
  • If you want to use the same app in all your push calls, you can omit token from the method, and pass fixed_token=... to the class instance or set GOTIFY_APP_TOKEN as an envionmnt variable instead.
  • If you want to set a fixed priority level for all your push calls, pass fixed_priority to the class instance.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gotipy-0.2.2.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

gotipy-0.2.2-py3-none-any.whl (3.8 kB view hashes)

Uploaded Python 3

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