bovine.activitystreams

class bovine.activitystreams.Actor(id: str, type: str = 'Person', name: str | None = None, preferred_username: str | None = None, inbox: str | None = None, outbox: str | None = None, followers: str | None = None, following: str | None = None, public_key: str | None = None, public_key_name: str | None = None, event_source: str | None = None, proxy_url: str | None = None, summary: str | None = None, icon: dict | None = None, url: str | None = None)

Actor class represents the basic ActivityStreams actor.

build(visibility=Visibility.PUBLIC)

Creates the json-ld representation of the actor.

class bovine.activitystreams.Collection(id: str, items: list)

class bovine.activitystreams.OrderedCollection(id: str, items: list | None = None, count: int = 0, first: str | None = None, last: str | None = None)

class bovine.activitystreams.OrderedCollectionPage(id: str, items: list, part_of: str, next: str | None = None, prev: str | None = None)

bovine.activitystreams.factories_for_actor_object(actor_object: dict) → Tuple[ActivityFactory, ObjectFactory]

Builds activity and object factories from actor object

class bovine.activitystreams.activity_factory.Activity(type: str, actor: str | None = None, followers: str | None = None, id: str | None = None, published: str | None = None, to: ~typing.Set[str] = <factory>, cc: ~typing.Set[str] = <factory>, name: str | None = None, summary: str | None = None, content: str | None = None, target: str | None = None, object: str | None = None)

A dataclass representing an ActivityStreams Activity

as_followers()

addresses the activity to followers, if they are set

as_public()

makes the activity public, i.e. public in to and followers in cc

as_unlisted()

makes the activity unlisted, i.e. public in cc and followers in to

build() → dict

converts the activity into a dict, that can be serialized to JSON

class bovine.activitystreams.activity_factory.ActivityFactory(actor_information)

Basic factory for Activity objects.

Usally created by a BovineClient

accept(obj, **kwargs)

Accept for object

announce(obj, **kwargs)

Announce for object

create(obj, **kwargs)

Activity of type Create from Object

delete(target, **kwargs)

Delete for target

follow(obj, **kwargs)

Follow for object

like(target, **kwargs)

Like for target

reject(obj, **kwargs)

Reject for object

undo(activity, **kwargs)

Undo for activity

update(obj, **kwargs)

Activity of type Update from Object

class bovine.activitystreams.object_factory.Object(type: str, attributed_to: str | None = None, followers: str | None = None, id: str | None = None, published: str | None = None, to: ~typing.Set[str] = <factory>, cc: ~typing.Set[str] = <factory>, name: str | None = None, summary: str | None = None, content: str | None = None, source: dict | None = None, width: int | None = None, height: int | None = None, in_reply_to: str | None = None, url: str | None = None, tag: ~typing.List[dict] = <factory>, attachment: ~typing.List[dict] = <factory>, href: str | None = None, icon: dict | None = None, media_type: str | None = None)

A dataclass representing an ActivityStreams Object

as_followers()

addresses the object to followers, if they are set

as_public()

makes the object public, i.e. public in to and followers in cc

as_unlisted()

makes the object unlisted, i.e. public in cc and followers in to

build()

Returns the resulting object as a dictionary

now()

Sets published to now in isoformat

class bovine.activitystreams.object_factory.ObjectFactory(actor_information=None, client=None)

ObjectFactory usually created through a BovineClient

article(**kwargs)

Creates an Article Object

event(**kwargs)

Creates an Event Object

async mention_for_actor_uri(actor_to_mention)

Creates a mention object for another actor. Requires client to be set.

Parameters:

actor_to_mention – The URI of the actor to mention

note(**kwargs)

Creates a Note Object

reply(obj, **kwargs)

Creates a reply for an object

class bovine.activitystreams.collection_helper.CollectionHelper(collection_id: str, actor, resolve=False)

Provides the ability to iterate over a Collection or OrderedCollection

Usage:

async for item in CollectionHelper(collection_id, bovine_client):
    do_something(item)

By setting resolve=True, items are always returned as a dictinary. Otherwise, they are returned as a string or dictionary depending on how the data is provided by the remote server.

async as_collection() → dict

Returns an ActivityStreams collection containing the items represented by the collection_id. This is useful for collections spread over multiple pages

bovine.activitystreams.utils.actor_for_object(data: dict) → str

Look up for the actor id either from attributedTo or actor

bovine.activitystreams.utils.copy_to_and_cc(origin: dict, destination: dict) → dict

Copies the audience from the origin object to the destination object

bovine.activitystreams.utils.fediverse_handle_from_actor(actor: dict) → str

Given an actor object, i.e. a dict, determines the fediverse handle

bovine.activitystreams.utils.id_for_object(data: dict | str | None) → str | None

Determines the id of an object

bovine.activitystreams.utils.is_public(data: dict) → bool

Determines if the object should be considered public based on its recipients

bovine.activitystreams.utils.recipients_for_object(data: dict) → set

Combines the recipients from to, cc, bto, bcc, audience into a set