imm: Execute arbitrary callbacks for each element of RSS/Atom feeds

[ library, program, public-domain, web ] [ Propose Tags ]

Cf README file


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.1.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.1.0, 0.5.0.0, 0.5.0.1, 0.5.1.0, 0.6.0.0, 0.6.0.1, 0.6.0.2, 0.6.0.3, 1.0.0.0, 1.0.1.0, 1.1.0.0, 1.2.0.0, 1.2.1.0, 1.3.0.0, 1.4.0.0, 1.5.0.0, 1.6.0.0, 1.6.1.0, 1.7.0.0, 1.8.0.0, 1.9.0.0, 1.10.0.0
Dependencies aeson, async, atom-conduit (>=0.7), avro (>=0.5), base-noprelude (>=4.7 && <5), binary, blaze-html, blaze-markup, bytestring, conduit, containers, dhall (>=1.27), directory (>=1.2.3.0), fast-logger, filepath, hashable, imm, microlens, mime-mail, monad-time, opml-conduit (>=0.7), optparse-applicative, pipes, pipes-bytestring, prettyprinter, prettyprinter-ansi-terminal, refined (>=0.4.1), relude, rss-conduit (>=0.5.1), safe, safe-exceptions, stm, stm-chans, text, time, timerep (>=2.0.0.0), typed-process, uri-bytestring, xml-conduit (>=1.5), xml-types [details]
License CC0-1.0
Author kamaradclimber, koral
Maintainer mail@cmoreau.info
Category Web
Home page https://github.com/k0ral/imm
Source repo head: git clone git://github.com/k0ral/imm.git
Uploaded by koral at 2020-05-31T16:58:35Z
Distributions NixOS:1.8.0.0
Executables imm-sendmail, imm-writefile, imm
Downloads 15287 total (868 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-05-31 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for imm-1.10.0.0

[back to package description]

imm

imm is a program that executes arbitrary callbacks (e.g. sending a mail, or writing a file) for each element of RSS/Atom feeds.

imm is written in Haskell, configured in Dhall. The project includes:

  • a main executable imm that users run directly
  • secondary executables (imm-writefile, imm-sendmail) which can be used as callbacks triggered by imm
  • a Haskell library, that exports functions useful to both the main executable and callbacks; the API is documented in Hackage.

Installation

Using nix

This repository includes a nix package that can be installed by running the following command at the root folder:

nix-build --attr exe

Without nix

imm's executables can be installed using cabal-install tool:

cabal install imm

Then, the following runtime dependencies must be installed separately and provided in PATH:

Configuration

Callbacks

Callbacks are configured through the $XDG_CONFIG_HOME/imm/callbacks.dhall file. A commented template file is bundled with the project.

imm will call each callback once per feed element, and will fill its standard input (stdin) with Avro-encoded binary data, which schema is described in file idl/callback.json.

Callback process is expected to return 0 in case of success, or any other exit code in case of failure, in which case the standard error output (stderr) will be displayed.

Example use cases

Online feed reader

For the sake of I-want-the-mutt-of-feed-readers zealots, it is possible to turn any mail reader into a feed reader, by having imm send an e-mail with unread elements to an arbitrary address. You can then browse your feeds through your favourite mail reader, and leverage any mail-related tool on your feeds. Bonus points if your mail reader is online as you can now access your feeds from any computer connected to the Internet.

Here is an example configuration:

let Callback : Type =
  { _executable : Text
  , _arguments : List Text
  }

let sendMail =
  { _executable = "imm-sendmail"
  , _arguments = []
  }

let config : List Callback = [ sendMail ]
in config

imm-sendmail does not have a built-in SMTP client, instead it must rely on an external SMTP client program, which is configured in $XDG_CONFIG_HOME/imm/sendmail.dhall (cf example bundled with the project.) imm-sendmail writes the mail bytestring to the standard input of the configured external program.

Offline read-it-later

imm is able to store a local copy of unread elements, to read them later while offline for example. External links won't work offline though.

let Callback : Type =
  { _executable : Text
  , _arguments : List Text
  }

let writeFile =
  { _executable = "imm-writefile"
  , _arguments = [ "-d", "/path/to/folder" ]
  }

let config : List Callback = [ writeFile ]
in config

Example usage

  • Subscribe to a feed through direct URL:

    imm subscribe -u http://your.feed.org
    
  • Subscribe to a feed through an alternate link:

    imm subscribe -a http://your.website.org
    
  • Import feeds from an OPML file:

    imm import < feeds.opml
    
  • List subscribed feeds:

    imm list
    
  • Show details about a feed:

    imm show http://your.feed.org
    
  • Unsubscribe from a feed:

    imm unsubscribe http://your.feed.org
    
  • Check for new elements without executing any action:

    imm --read-only run --no-callbacks
    
  • Execute configured callbacks for each new element from all subscribed feeds:

    imm run --all