Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softwarefactory-project/matrix-client-haskell
Matrix.org haskell client library
https://github.com/softwarefactory-project/matrix-client-haskell
haskell matrix matrix-org
Last synced: about 2 months ago
JSON representation
Matrix.org haskell client library
- Host: GitHub
- URL: https://github.com/softwarefactory-project/matrix-client-haskell
- Owner: softwarefactory-project
- Created: 2021-06-05T12:56:20.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-23T12:48:45.000Z (11 months ago)
- Last Synced: 2024-05-02T05:02:49.623Z (8 months ago)
- Topics: haskell, matrix, matrix-org
- Language: Haskell
- Homepage:
- Size: 178 KB
- Stars: 24
- Watchers: 8
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# matrix-client-haskell
> [matrix] is an open network for secure, decentralized communication.
This project contains Haskell libraries for [matrix.org](https://matrix.org).
This allows you to rapidly integrate matrix events in your application.
## matrix-client
[](https://hackage.haskell.org/package/matrix-client)
A low level library to implements the [client-server spec](https://matrix.org/docs/spec/client_server/latest):
### Implemented
- [x] Basic room membership to leave and join rooms
- [x] Basic sync to read room's timeline
- [x] Sending text events
- [x] Identity lookup
- [x] Invites
### Next/Missing
- [ ] Rich messages
- [ ] Decoders to support OLM with https://github.com/livmackintosh/matrix-sdk
- [ ] The rest of the HTTP API...
## Contribute
To work on this project you need a Haskell toolchain, for example on fedora:
```ShellSession
$ sudo dnf install -y ghc cabal-install && cabal update
```
Run the tests:
```ShellSession
$ cabal build all && cabal test all
```
Some tests requires a local matrix server, run integration service:
```ShellSession
# In another terminal:
$ nix develop -c conduit-start
# Before running cabal test:
$ export $(nix develop -c conduit-setup)
$ cabal test all
```
Restart the commands to run the test on a fresh environment.
If you experience any difficulties, please don't hesistate to raise an issue.