Gyr

Come talk with us about Gyr on matrix at
#gyr:matrix.org!

Gyr is a framework for quickly developing matrix
application
services in
python3. It provides a WSGI application and several other utilities for working
with matrix.

Gyr is designed to be a fairly thin layer of abstraction over application
service api—just enough to make things easy without pushing you so far from the
spec that you get confused.

Status

Gyr hasn’t been worked on in months. For a python application-service framework
under more active development I recommend checking out Cadair’s
python-appservice-framework.
Use at your own risk currently, and be especially aware of bugs like this one
caused by Gyr’s lack of
asynchronicity. I hope to return to
this framework once I land async in
matrix-python-sdk.

Very alpha! Most of the main functionality I’d envisioned is present, however
there’s poor to non-existent documentation and no unit tests. Contributions are
welcome.

Installation

Please install gyr with pip (in a virtualenv if you prefer):

pip install gyr

Usage

I’ll try to show a bunch of functionality here, but see examples directory for
further usage examples.

from gyr import server, matrix_objects
application = server.Application("http://localhost:8008", "foobar")
as_user = matrix_objects.MatrixUser("@example_as:example.com", application.Api)
room = as_user.create_room(alias="#foo:example.com", is_public=True)
def rm_hndlr(room_id):
    # Gyr will create a user for you if this returns true!
    return False
def user_hndlr(user_id):
    # Gyr will create the room for you if this returns true!
    return False
def txn_hndlr(events):
    for event in events:
        room.send_notice(
        "Received event type {} in room {} from user {}".format(event.type,
                                                                event.room,
                                    event.user)
    )
    return True
application.add_handlers(room_handler=rm_hndlr, transaction_handler=txn_hndlr,
                         user_handler=user_hndlr)

Save as example.py. Then from the commandline:

gunicorn example:application

Projects Using Gyr

• matrix_relay
• Open a PR or ping me on matrix
  with your project. I’d love to hear about anyone building on gyr!

Modules

gyr.server

server provides the WSGI application class. An instance of
gyr.server.Application functions as the WSGI app and will automatically
parse the request and call any handlers provided to the Application
instance.

gyr.api

api provides a helpful wrapper for
matrix-python-sdk‘s
api, changing the parts of the api that are different for application
services until such time as similiar changes are merged upstream. Pull
requests for these changes have been submitted, and some changes already
merged into master.

For working with the api, I recommend using the wrappers built around
specific objects which are available in gyr.matrix_objects.

gyr.matrix_objects

matrix_objects provides helpful wrapper classes around matrix users,
events and rooms. It is not designed to be easily used for the normal
client-server api but should provide most necessary functionality for
the manipulation of users and rooms that an application service might
need to do.

Pull requests enriching the functionality of these classes are very
welcome.