https://github.com/TeMPOraL/cl-pushover

Common Lisp bindings to Pushover
https://github.com/TeMPOraL/cl-pushover

common-lisp pushover

Last synced: about 2 months ago
JSON representation

Common Lisp bindings to Pushover

• Host: GitHub
• URL: https://github.com/TeMPOraL/cl-pushover
• Owner: TeMPOraL
• License: mit
• Created: 2016-07-19T14:35:40.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-07-26T22:52:03.000Z (about 8 years ago)
• Last Synced: 2024-01-27T09:06:44.660Z (8 months ago)
• Topics: common-lisp, pushover
• Language: Common Lisp
• Size: 14.6 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

• curated-awesome-cl - cl-pushover - Common Lisp bindings to Pushover. [MIT][200]. (REPLs ##)

README

        
#+title: CL-PUSHOVER - Common Lisp bindings to Pushover

#+startup: hidestars

An utility library for using [[https://pushover.net/][Pushover]] notifications in Common Lisp.

The goal of this library is complete coverage of Pushover APIs. However, it is being

developed as a part of another project that occupies most of my time, so features

will be added as needed or as the time allows.

* Status

** Implemented

   - Full API for [[https://pushover.net/api#messages][sending Pushover notifications]].

** To be implemented

   - Actual handling of [[https://pushover.net/api#friendly][errors reported by Pushover API]].

   - API for [[https://pushover.net/api#receipt][querying receipts]].

   - API for [[https://pushover.net/api#receipt][cancelling emergency-priority retries]].

   - API for [[https://pushover.net/api#verification][user/group verification]].

   - API for [[https://pushover.net/api/subscriptions][subscriptions]].

   - API for [[https://pushover.net/api/groups][groups]].

   - API for [[https://pushover.net/api/licensing][licensing]].

   - Toolkit for the [[https://pushover.net/api/client][Open Client API]] (possibly as an another library).

* How to use

  Include this library in your Quicklisp's local projects. Load with standard

  #+BEGIN_SRC lisp

    (ql:quickload :cl-pushover)

  #+END_SRC

  To send a Pushover notifications, you need to provide at least three pieces of information:

  - your Pushover app token

  - destination user/group token

  - message body

  The simplest request would be:

  #+BEGIN_SRC lisp

    (cl-pushover:send-pushover :token "your app token" :destination-key "destination user/group token" :message "Body of the message.")

  #+END_SRC

  You can omit the ~:token~ parameter by setting it in a variable ~cl-pushover:*default-app-token*~.

  For more, refer to the docstring of ~cl-pushover:send-pushover~ function and the documentation of Pushover API.

  Note, that if you want to skip type/sanity checks for some reason (e.g. efficiency), you can call

  ~cl-pushover::%send-pushover~, which is an unsafe version of the ~cl-pushover:send-pushover~ function.

  Please refer to the code for details.

  Examples of other Pushover APIs will be added as the support for those APIs is implemented.

* Contributions

  Issues and pull requests welcome :).

* License

  MIT. See [[file:LICENSE][LICENSE]] file.