https://github.com/madmax28/navi

Navi is a minimal Matrix notification bot
https://github.com/madmax28/navi

Last synced: about 2 months ago
JSON representation

Navi is a minimal Matrix notification bot

• Host: GitHub
• URL: https://github.com/madmax28/navi
• Owner: madmax28
• License: apache-2.0
• Created: 2017-02-05T21:50:07.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-10-20T20:40:49.000Z (almost 2 years ago)
• Last Synced: 2024-04-22T01:21:12.664Z (5 months ago)
• Language: Python
• Size: 11.7 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - madmax28/navi - Navi is a minimal Matrix notification bot (others)

README

        
Navi - A minimal Matrix notification bot

========================================

Navi is a tiny bot for [Matrix][1] that sends notifications to users. It is build upon the [Matrix Python SDK][2].

The motivation behind Navi is to send notifications from anywhere to everywhere. This includes the push services GCM and APNs that [Riot][4] bridges to, without having to rely on services such as Pushbullet or Pushover.

The first time you use it, Navi creates a new room and invites your user to it. The room will be reused afterwards. If you leave the room, so will Navi, and invite you to a new room.

You can also specify room ids that Navi should join and push to directly. If a private room is specified, make sure that you have invited Navi to that room.

Usage

=====

```Shell

$ navi -q -m "Hey, listen"

$ tail -10 some.log | navi

Connecting to https://matrix.org...

Current rooms:

        !sjgkDaSSBKduHRADCe:matrix.org

Pushing message...

Connection closed.

``` 

Installation

============

1. Initialize the Matrix SDK submodule: `git submodule update --init`

2. Link it into your path (e.g. `ln -s /path/to/navi.py /usr/local/bin/navi`)

3. Set up a matrix account for Navi

4. Create a [configuration][3] in `~/.navi.cfg`:

Dependencies

------------

The Matrix Python SDK requires [requests][5]. Install it with `pip install requests`.

Navi uses filetype. Install it with `pip install filetype`.

[1]: https://matrix.org

[2]: https://github.com/matrix-org/matrix-python-sdk

[3]: ./example.cfg

[4]: https://riot.im

[5]: https://pypi.python.org/pypi/requests