Flask-ActivityPub

Flask-ActivityPub is a Flask extension that should enable the developer to add social networking ActivityPub support to a Flask application. This could be the main purpose of the application, or could be implemented in a blueprint as a subsection (examples coming later).

It's WAY EARLY days and there is little code yet, though reading testapp/app.py might be of use. Please Stand By.

Design

Flask-ActivityPub is intended to provide the API endpoints and client functions to support federation with other social sites that implement the ActivityPub protocol. This will allow activity on the site to be shared with federated services.

from flask import Flask
from flask_activitypub import ActivityPub

app = Flask("test app")

# configure application, blueprints, database, etc.

# add ActivityPub APIs
activity_app = ActivityPub(app)

This adds the ActivityPub extension, which provides a method for adding handlers for each ActivityPub endpoint.

FollowingProvider here is a subclass of ActivityPubProvider, an abstract superclass provided by Flask-ActivityPub that defines the get_*,

class FollowingProvider(ActivityPubProvider):
    """
    Data provider for Follow data
    """
    def get_objects(self, handle):
        user = storage.get_user_by_handle(handle)
        return [
            self.create_follow(handle, follow.id) for 
            follow in user.follow_collection]

    def get_object(self, handle, obj_id):
        user = storage.get_user_by_handle(handle)
        return [
            self.create_follow(handle, follow.id) for 
            follow in user.follow_collection]

    def create_object(self, handle, **kwargs):
        user = storage.get_user_by_handle(handle)
        actor = kwargs.get("actor")

    def delete_object(self, handle, obj_id):
        pass


# Set FollowingProvider as the provider for the follow endpoint:
activity_app.follow_provider(FollowingProvider)

The method get_objects is called by the get() request handler to return data for the request.

Acknowledgements

I've learned a lot of this from Rowan esp from reading the Smilodon source code, tiny bits of which I've literally copied and pasted while trying to make things work. Additionally, I'm learning a lot from Christian Webber and his ActivityStreams work with https://github.com/w3-social/activipy.