Snapper

About

Snapper is a family of crates for implementing matrix utility and administration bots in Rust.

Project structure

Snapper is divided into the following crates:

• snapper-box - Encrypted persistent store used by snapper
• snapper-client - Low level, bot oriented matrix client
• snapper - High level bot api
• snapper-bot - Reference bot implemented with snapper

Built With

Under the hood, snapper uses:

• executor - async_std
• http client - surf in curl client mode

Getting started

TODO

Prerequisites

This project uses nix for development. While it does use a nix flake, the repository makes use of compatibility shims to allow development and building without needing to be on unstableNix.

Once you have nix installed, simply run, if you have flakes and nix-command enabled:

nix develop

or if you do not:

nix-shell

This project also has a .evnrc file, for use with direnv.

Usage

TODO

Contributing

Take a look at CONTRIBUTING.md

Documentation

Please take a look at the CHANGELOG.md and the rustdoc.

Rustdoc

The up to date, current trunk rustdoc for each crate can be found at the following locations:

• snapper-box
• snapper-client
• snapper
• snapper-bot