Giter Club home page Giter Club logo

notipy-client's Introduction

Notipy Client

Python client for Notipy Server

A Python client which talks to the Notipy Server-REST-API.

Basic Usage

The following code snippet sends a Hello World message to the Telegram user with the username myuser.

from notipy import Notipy, BackendType

# Hostname and port of the notipy-server instance
HOST = "localhost"
PORT = 8000

notifier = Notipy(HOST, PORT)
notifier.send(BackendType.TELEGRAM, "myuser", "Hello World")

Templating

The client uses the Jinja2 Templating Engine to support templated messages. All the parameters for Jinja2 can be passed as keyword arguments to the send_templated function.

from pathlib import Path
from notipy import Notipy, BackendType

# Hostname and port of the notipy-server instance
HOST = "localhost"
PORT = 8000
# Template directory
TEMPLATE_DIR = Path("/var/lib/templates")

notifier = Notipy(HOST, PORT, template_dir=TEMPLATE_DIR)
notifier.send_templated(BackendType.TELEGRAMGROUP, "mygroup", "mytemplate", foo="bar")

Templates always have the file name suffix .tmpl. The mytemplate.tmpl file in the /var/lib/templates directory would look like this:

Hello {{ foo }}!

So mygroup would recive the message: Hello bar!.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.