roboherd 0.1.5__py3-none-any.whl → 0.1.6__py3-none-any.whl

roboherd/annotations/__init__.py

@@ -1,7 +1,7 @@
 from fast_depends import Depends
-from typing import Annotated, Callable, Awaitable
+from typing import Annotated
 
-from almabtrieb import Almabtrieb
+from .common import PublishObject, PublishActivity  # noqa
 
 
 def get_raw(data: dict) -> dict:
@@ -41,28 +41,3 @@ Activity = Annotated[dict, Depends(get_activity)]
 
 EmbeddedObject = Annotated[dict, Depends(get_embedded_object)]
 """The embedded object in the activity as parsed by muck_out"""
-
-Publisher = Callable[[dict], Awaitable[None]]
-"""Type returned by the publishing functions"""
-
-
-def construct_publish_object(connection: Almabtrieb, actor_id: str) -> Publisher:
-    async def publish(data: dict):
-        await connection.trigger("publish_object", {"actor": actor_id, "data": data})
-
-    return publish
-
-
-def construct_publish_activity(connection: Almabtrieb, actor_id: str) -> Publisher:
-    async def publish(data: dict):
-        await connection.trigger("publish_activity", {"actor": actor_id, "data": data})
-
-    return publish
-
-
-PublishObject = Annotated[Publisher, Depends(construct_publish_object)]
-"""Allows one to publish an object as the actor. Assumes cattle_grid has the extension `simple_object_storage` or equivalent"""
-
-
-PublishActivity = Annotated[Publisher, Depends(construct_publish_activity)]
-"""Allows one to publish an activity as the actor. Assumes cattle_grid has the extension `simple_object_storage` or equivalent"""

roboherd/annotations/bovine.py

@@ -1,8 +1,8 @@
 """Test documentation"""
 
-from typing import Annotated
+from typing import Annotated, Awaitable, Callable
 from fast_depends import Depends
-from .common import Profile
+from .common import Profile, PublishObject
 
 try:
     from bovine.activitystreams import factories_for_actor_object
@@ -39,3 +39,29 @@ ActivityFactory = Annotated[BovineActivityFactory, Depends(get_activity_factory)
 
 ObjectFactory = Annotated[BovineObjectFactory, Depends(get_object_factory)]  # type: ignore
 """The object factory of type [bovine.activitystreams.object_factory.ObjectFactory][]"""
+
+
+try:
+    import markdown
+
+    def get_markdown_poster(  # type: ignore
+        object_factory: ObjectFactory, publish_object: PublishObject
+    ):
+        async def publish_markdown(message: str):
+            content = markdown.markdown(message)
+            note = object_factory.note(content=content).as_public().build()  # type: ignore
+            await publish_object(note)
+
+        return publish_markdown
+
+except ImportError:
+
+    def get_markdown_poster() -> None:
+        raise ImportError("bovine not installed")
+
+
+MarkdownPublisher = Callable[[str], Awaitable[None]]
+"""Type of the markdown publisher"""
+
+MarkdownPoster = Annotated[MarkdownPublisher, Depends(get_markdown_poster)]  # type: ignore
+"""A function that takes a markdown string and posts it as the content of a note"""

roboherd/annotations/common.py

@@ -1,5 +1,8 @@
 from fast_depends import Depends
-from typing import Annotated
+from typing import Annotated, Callable, Awaitable
+
+from almabtrieb import Almabtrieb
+
 
 from roboherd.cow import RoboCow
 
@@ -12,3 +15,29 @@ def get_profile(cow: RoboCow) -> dict:
 
 Profile = Annotated[dict, Depends(get_profile)]
 """The profile of the cow"""
+
+
+Publisher = Callable[[dict], Awaitable[None]]
+"""Type returned by the publishing functions"""
+
+
+def construct_publish_object(connection: Almabtrieb, actor_id: str) -> Publisher:
+    async def publish(data: dict):
+        await connection.trigger("publish_object", {"actor": actor_id, "data": data})
+
+    return publish
+
+
+def construct_publish_activity(connection: Almabtrieb, actor_id: str) -> Publisher:
+    async def publish(data: dict):
+        await connection.trigger("publish_activity", {"actor": actor_id, "data": data})
+
+    return publish
+
+
+PublishObject = Annotated[Publisher, Depends(construct_publish_object)]
+"""Allows one to publish an object as the actor. Assumes cattle_grid has the extension `simple_object_storage` or equivalent"""
+
+
+PublishActivity = Annotated[Publisher, Depends(construct_publish_activity)]
+"""Allows one to publish an activity as the actor. Assumes cattle_grid has the extension `simple_object_storage` or equivalent"""

roboherd/examples/scarecrow.py

@@ -20,3 +20,8 @@ bot = RoboCow(
 async def startup(publish_object: PublishObject, object_factory: ObjectFactory):
     note = object_factory.note(content="Booo! 🐦").as_public().build()  # type: ignore
     await publish_object(note)
+
+
+# @bot.startup
+# async def startup(poster: MarkdownPoster):
+#     await poster("__Booo!__ 🐦")

{roboherd-0.1.5.dist-info → roboherd-0.1.6.dist-info}/METADATA

@@ -1,7 +1,9 @@
 Metadata-Version: 2.4
 Name: roboherd
-Version: 0.1.5
+Version: 0.1.6
 Summary: A Fediverse bot framework
+Project-URL: Documentation, https://bovine.codeberg.page/roboherd/
+Project-URL: Repository, https://codeberg.org/bovine/roboherd
 Requires-Python: >=3.11
 Requires-Dist: aiohttp>=3.11.12
 Requires-Dist: almabtrieb[mqtt]>=0.1.0a1
@@ -14,6 +16,7 @@ Requires-Dist: tomli-w>=1.1.0
 Requires-Dist: watchfiles>=1.0.4
 Provides-Extra: bovine
 Requires-Dist: bovine>=0.5.15; extra == 'bovine'
+Requires-Dist: markdown>=3.7; extra == 'bovine'
 Description-Content-Type: text/markdown
 
 # Roboherd

{roboherd-0.1.5.dist-info → roboherd-0.1.6.dist-info}/RECORD

@@ -4,9 +4,9 @@ roboherd/register.py,sha256=Gqa5aT2supVJMj7z21btMYRma3_WW0oK5gjZftr048s,976
 roboherd/test_validators.py,sha256=UiFgJkutmXBLjGpdLP2IBYCEf75quwnRHX7Z51G8Xqo,222
 roboherd/util.py,sha256=nrFRtyfvMQ8oXoGDYxmCAXcIN14dWBAPGv0cI_B_TP0,1710
 roboherd/validators.py,sha256=2mc43ZGwFazp4f3B9J4RxZCU4Y_ErSNotib8MnYVtmY,140
-roboherd/annotations/__init__.py,sha256=UhDSVQ4cj2iwIr5qn6dZMAyyY-A9KMJHnqhyVYsRYww,2095
-roboherd/annotations/bovine.py,sha256=qXkliFVT63BfGn820Bopwd7O41ofP7VbNomxyit4zBg,1494
-roboherd/annotations/common.py,sha256=DN1jt1P79pU7XnmiocwTQTTQnn3vJlSSkP8kiHGAbfs,334
+roboherd/annotations/__init__.py,sha256=BrP5UWiVnh8FwmHc6wEY3G69BStidGUpF8uP4Ea5-dg,1140
+roboherd/annotations/bovine.py,sha256=cFLUSFzTulikNjZb1lLq5v4tGjL1i7_dR3H6wimegCg,2322
+roboherd/annotations/common.py,sha256=n5rm8WTgsg116RczKdzm_VoPg1mBk_IMf2V7l8UgWKQ,1351
 roboherd/cow/__init__.py,sha256=MlMvjFbodwZf6vpKlPfIpSn5SHu9IugacSH5ylbySTY,5826
 roboherd/cow/const.py,sha256=fj5nUJUIlcpr1AU2Ur55ToR7iVmYv4UnfdxiQwguv-k,166
 roboherd/cow/handlers.py,sha256=k5Tc1M--wqmZ2EZvzIfID4dp8XE0rN18puMTKkNVjjE,1491
@@ -24,7 +24,7 @@ roboherd/examples/meta.py,sha256=tFhHe-DJn2J13Mm22f-gFm5I8_3uQwLU4mAkrK2xzEM,170
 roboherd/examples/moocow.py,sha256=DMPuR8XBpRRHKXFZM-2_VLYLWx8Iz4OdcE0QTVtYSFs,1097
 roboherd/examples/number.py,sha256=Sj9aYfdtzANUfWVJnoX73zEvDNVcdrr-STZDSwNRHlI,2003
 roboherd/examples/rooster.py,sha256=5_rPGLQTLv1s0cyE6l7WXLum-QLpQZ2p63YBkfrxKFw,596
-roboherd/examples/scarecrow.py,sha256=KGZP0e5WHkCNSnGSlW3BeymcRZ4PqaWjAs_q5IC-1fE,649
+roboherd/examples/scarecrow.py,sha256=CgQuI7smKBJdeMiL8fY5SP1itH5GaFRAoX3I3QGF3rw,748
 roboherd/herd/__init__.py,sha256=6jWgYnuJOpXtYS03mdjEgWd0zXv5kj9w9d7K6UsCPbc,3068
 roboherd/herd/builder.py,sha256=MSVPRF0Jsxure9kdyCoYJHQ7nYilGAD0_uQaGQ-rQyE,619
 roboherd/herd/processor.py,sha256=ncXsYfuTRTT_0-K453COF_oAiGBJN0u5eP8NoeZmWik,1042
@@ -38,7 +38,7 @@ roboherd/herd/manager/load.py,sha256=BoeBID2UGP--sIKwITABQkQv2lMc9Y8pyp7_nleu2bw
 roboherd/herd/manager/test_config.py,sha256=CnoqQ_exrpQdBWVoGxSns3HpccqgmhH9mNJIPTCKKAs,1665
 roboherd/herd/manager/test_load.py,sha256=zyu5LIChMfTnxu_tYK63-bSOHYn1K1zUlbDY5DkE3GY,514
 roboherd/herd/manager/test_manager.py,sha256=9pSMaH7zmN-zagYCIBpQcV3Q0sBT7XZSCvsmLVC0rOI,1047
-roboherd-0.1.5.dist-info/METADATA,sha256=TU89GQjIVilPWX8Lc_It5tNYKCPuoI0MXaWdN-t25CY,830
-roboherd-0.1.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-roboherd-0.1.5.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
-roboherd-0.1.5.dist-info/RECORD,,
+roboherd-0.1.6.dist-info/METADATA,sha256=DvhOfgjAb92py9-vVqKR0bbsRhx5jau-_DVt_mLB31M,1007
+roboherd-0.1.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+roboherd-0.1.6.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
+roboherd-0.1.6.dist-info/RECORD,,