Skip to content

gaoliang/pypushdeer

Repository files navigation

pypushdeer

PushDeer SDK for Python.

install

pip install pypushdeer

Usage:

1. Use pushdeer default server

from pypushdeer import PushDeer

pushdeer = PushDeer(pushkey="your_push_key")
pushdeer.send_text("hello world", desp="optional description")
pushdeer.send_markdown("# hello world", desp="**optional** description in markdown")
pushdeer.send_image("https://github.com/easychen/pushdeer/raw/main/doc/image/clipcode.png")
pushdeer.send_image(
    "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=")

2. Use self-hosted server

from pypushdeer import PushDeer

pushdeer = PushDeer(server="https://your-server-here", pushkey="your_push_key")

3. Use unique configuration for each message

from pypushdeer import PushDeer

pushdeer = PushDeer()
pushdeer.send_text("hello world", server="some_server", pushkey="some_key")

TODO:

  • unit test
  • exception handling
  • arguments validate