[ANN] org-jami-bot

[ANN] org-jami-bot

[Hanno Perrey]

Dear fellow org-users,

I have just released two new packages that scratch an old itch of mine:
capturing thoughts, quick notes and URLs while "on the road" with only
my mobile phone around. Messaging myself feels most natural, so that is
what I went with: triggering a capture via GNU Jami, the distributed
private messenger.

The first package, =jami-bot= provides something of a framework to
handle incoming text and file messages. =org-jami-bot= provides hooks
and functions that extend this to Org mode captures. Any text or file is
being captured, but even simple commands (prefixed with '!') are
possible, for example:

#+begin_example
!schedule monday
buy oat milk
#+end_example

Schedules a todo entry for next monday.

#+begin_example
!url blog emacs news
https://sachachua.com/blog/2023/04/2023-04-17-emacs-news/
#+end_example

Uses =org-capture-ref= to capture the URL and tags it with
:blog:emacs:news:.

This last command is technically not part of =org-jami-bot= as it
requires =org-capture-ref= to be installed and configured -- but it only
takes relatively little code to realize and I have documented it in a
blog post: https://www.hoowl.se/org-capture-ref-jami-bot.html

Further extensions are quite easily possible, I believe.

More examples and detailed documentation can be found here:
https://www.hoowl.se/org-jami-bot.html


The code to both packages will eventually be on Melpa, but for now it
can be found here:
https://gitlab.com/hperrey/jami-bot
https://gitlab.com/hperrey/org-jami-bot


Feedback, comments and ideas for further development are welcome!


Thanks and cheers,

Hanno

--
Hanno Perrey
https://hoowl.se

Re: [ANN] org-jami-bot

[Marcin Borkowski]

On 2023-04-17, at 21:22, Hanno Perrey <hanno@hoowl.se> wrote:

> Dear fellow org-users,
>
> I have just released two new packages that scratch an old itch of mine:
> capturing thoughts, quick notes and URLs while "on the road" with only
> my mobile phone around. Messaging myself feels most natural, so that is
> what I went with: triggering a capture via GNU Jami, the distributed
> private messenger.

Hi,

I've never heard about Jami before -- I'll definitely check it out!  And
your package looks _very_ cool.  Thanks!

Best,

-- 
Marcin Borkowski
http://mbork.pl

Re: [ANN] org-jami-bot

[Ihor Radchenko]

Hanno Perrey <hanno@hoowl.se> writes:

> The first package, =jami-bot= provides something of a framework to
> handle incoming text and file messages. =org-jami-bot= provides hooks
> and functions that extend this to Org mode captures. Any text or file is
> being captured, but even simple commands (prefixed with '!') are
> possible, for example:
>
> #+begin_example
> !schedule monday
> buy oat milk
> #+end_example
>
> Schedules a todo entry for next monday.

Thanks for sharing!
This is pretty impressive.
Do you plan to publish these packages on ELPA?
If so, I can see the packages being referenced in
https://orgmode.org/worg/#use-effectively

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [ANN] org-jami-bot

[Russell Adams]

On Mon, Apr 17, 2023 at 09:22:48PM +0200, Hanno Perrey wrote:
>
> Dear fellow org-users,
>
> I have just released two new packages that scratch an old itch of mine:
> capturing thoughts, quick notes and URLs while "on the road" with only
> my mobile phone around. Messaging myself feels most natural, so that is
> what I went with: triggering a capture via GNU Jami, the distributed
> private messenger.
>
> The first package, =jami-bot= provides something of a framework to
> handle incoming text and file messages. =org-jami-bot= provides hooks
> and functions that extend this to Org mode captures. Any text or file is
> being captured, but even simple commands (prefixed with '!') are
> possible, for example:

Hanno, this is brilliant.

I rely heavily on using XMPP notifications with my Emacs/Org setup for
appointments. I run a local program for send-xmpp to fire off messages
that alert my multiple PC's and my cell phone on my XMPP account.

I hadn't considered sending data BACK. That's awesome!

How hard would it be to port this to a message agnostic style where
other methods could be used?

I've used Jami before, but I consider it VOIP software trying to
become messenger, where XMPP is messenger trying to become VOIP. I've
had battery problems in the past with Jami, but that was back when it
was called Ring.

I may have to try and adapt this to my workflow.

Thanks for sharing!

------------------------------------------------------------------
Russell Adams                            RLAdams@AdamsInfoServ.com
                                    https://www.adamsinfoserv.com/

Re: [ANN] org-jami-bot

[Hanno]

>Thanks for sharing!
>This is pretty impressive.
>Do you plan to publish these packages on ELPA?
>If so, I can see the packages being referenced in
>https://orgmode.org/worg/#use-effectively
>

Hej Ihor!

Thank you for your kind words and for suggesting to add a reference on worg! Putting a package on ELPA is on my bucket list, so why not? ;)

I do not have the paperwork in place yet. I recently changed employment and am under the impression that it should not be a problem though.

I will let you know once that is done!

Best wishes,
Hanno

Re: [ANN] org-jami-bot

[Hanno Perrey]

>Hanno, this is brilliant.
>
>I rely heavily on using XMPP notifications with my Emacs/Org setup for
>appointments. I run a local program for send-xmpp to fire off messages
>that alert my multiple PC's and my cell phone on my XMPP account.
>
>I hadn't considered sending data BACK. That's awesome!
>
>How hard would it be to port this to a message agnostic style where
>other methods could be used?
>
>I've used Jami before, but I consider it VOIP software trying to
>become messenger, where XMPP is messenger trying to become VOIP. I've
>had battery problems in the past with Jami, but that was back when it
>was called Ring.
>
>I may have to try and adapt this to my workflow.

Hej Russell!

Thank you! I am very glad that you liked the idea and consider adding it to your workflow!

With some refactoring, it should absolutely be possible to make the bot and capturing more protocol-agnostic. The stack would be more like 
jami.el/xmpp.el->chat-bot.el->org-capture-bot.el

So some more abstraction would be needed but it could be doable without too much work and make sense from a code re-usability perspective.

Do you know of a maintained XMPP client written in Elisp to start looking into?

I'd be happy to discuss this in mode detail with you if you are up for working together in this direction! :)

Best wishes,
Hanno

Re: [ANN] org-jami-bot

[Max Nikulin]

On 18/04/2023 02:22, Hanno Perrey wrote:
> =org-jami-bot= provides hooks
> and functions that extend this to Org mode captures.

Thank you for the idea (I can not say anything concerning implementation 
yet) to take advantage of messenger infrastructure for CLI variant of 
org-capture. Certainly it is an option when ssh is not available or 
overkill. It has caused change of my attitude in respect to chat bots.

Are there chat clients optimized as a kind of terminals for CLI 
operation? I mean GNU readline features like TAB completion, incremental 
reverse history search C-r, substituting last argument from previous 
command M-., executing with selection of next command for edit C-o, 
expand history "!" substitutions M-^, multiple kill buffers, etc.? Since 
chat driven RPC is more asynchronous than regular terminals, perhaps 
variants of sorting for command "output" should be implemented as 
threaded grouping or receive order sorting in mail clients.

Earlier I was forced to use a messenger to manage virtual machines even 
from a desktop (so when full-size keyboard and mouse are available). 
That time I wrote a python tool that was called from shell and sent 
arguments to HTTP RPC endpoint used by that bot. Even though it was one 
way communication (responses were sent to the messenger), I found it 
much more convenient. That is why I started to hate inappropriately used 
chat bots.

I admit that messengers have features allowing to create some kinds of 
UI with less efforts than web or native applications. It would be great 
to have specialized clients and protocol features dedicated for CLI, not 
human communications.

Back to Org, are there mobile Org applications that support org-capture 
and org-protocol? I mean purely local using of mobile terminal 
application and simple tool to sent intentions to the Org App?

Re: [ANN] org-jami-bot

[Ihor Radchenko]

Hanno Perrey <hanno@hoowl.se> writes:

> Do you know of a maintained XMPP client written in Elisp to start looking into?

Also, consider ERC and ement.el.
For XMPP, https://codeberg.org/emacs-jabber/emacs-jabber, AFAIK.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [ANN] org-jami-bot

[Ihor Radchenko]

Hanno <hanno@hoowl.se> writes:

> Thank you for your kind words and for suggesting to add a reference on worg! Putting a package on ELPA is on my bucket list, so why not? ;)
>
> I do not have the paperwork in place yet. I recently changed employment and am under the impression that it should not be a problem though.
>
> I will let you know once that is done!

May I know if you managed to get any progress on this?
If you encounter any difficulties with the paperwork, we can try to help.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>