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

roboherd/__init__.py

@@ -0,0 +1,25 @@
+"""Main roboherd module. Should contain all necessary elements to build a robocow"""
+
+from .cow import RoboCow
+from .annotations import (
+    PublishObject,
+    PublishActivity,
+    RawData,
+    ParsedData,
+    Activity,
+    EmbeddedObject,
+)
+from .annotations.bovine import MarkdownPoster, ObjectFactory, ActivityFactory
+
+__all__ = [
+    "RoboCow",
+    "RawData",
+    "ParsedData",
+    "Activity",
+    "EmbeddedObject",
+    "MarkdownPoster",
+    "ActivityFactory",
+    "ObjectFactory",
+    "PublishObject",
+    "PublishActivity",
+]

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/cow/__init__.py

@@ -81,6 +81,14 @@ class RoboCow:
         metadata=dict(description="Internal data for the cow"),
     )
 
+    @staticmethod
+    def create(**kwargs):
+        """Creates a new cow. We note that
+        `RoboCow.create(name="my name")` is equivalent
+        to `RoboCow(information=Information(name="my name"))`.
+        """
+        return RoboCow(information=Information(**kwargs))
+
     def action(self, action: str = "*", activity_type: str = "*"):
         """Adds a handler for an event. Use "*" as a wildcard.
 

roboherd/examples/dev_null.py

@@ -1,13 +1,10 @@
-from roboherd.cow import RoboCow
-from roboherd.cow.types import Information
+from roboherd import RoboCow
 
 from .meta import meta_information
 
-bot = RoboCow(
-    information=Information(
-        name="/dev/null",
-        description="""I don't do anything.""",
-        handle="devnull",
-        meta_information=meta_information,
-    )
+bot = RoboCow.create(
+    name="/dev/null",
+    description="""I don't do anything.""",
+    handle="devnull",
+    meta_information=meta_information,
 )

roboherd/examples/json_echo.py

@@ -1,24 +1,19 @@
 import json
 
-from roboherd.cow import RoboCow
-from roboherd.annotations import RawData, PublishObject
-from roboherd.annotations.bovine import ObjectFactory
+from roboherd import RoboCow, RawData, PublishObject, ObjectFactory
 
-from roboherd.cow.types import Information
 from .meta import meta_information
 
-bot = RoboCow(
-    information=Information(
-        handle="jsonecho",
-        name="JSON Echo {}",
-        description="""<p>I'm a silly bot that replies to
+bot = RoboCow.create(
+    handle="jsonecho",
+    name="JSON Echo {}",
+    description="""<p>I'm a silly bot that replies to
 you with the JSON as received through a HTTP
 post request by 
 <a href="https://codeberg.org/helge/cattle_grid">cattle_grid</a>.</p>
     
     """,
-        meta_information=meta_information,
-    )
+    meta_information=meta_information,
 )
 
 

roboherd/examples/moocow.py

@@ -1,22 +1,18 @@
 import logging
 
-from roboherd.cow import RoboCow
-from roboherd.annotations import EmbeddedObject, PublishObject
-from roboherd.cow.types import Information
+from roboherd import RoboCow, EmbeddedObject, PublishObject
 from .meta import meta_information
 
 logger = logging.getLogger(__name__)
 
-moocow = RoboCow(
-    information=Information(
-        handle="moocow",
-        name="The mooing cow 🐮",
-        description="""I'm a cow that likes to moo.
+moocow = RoboCow.create(
+    handle="moocow",
+    name="The mooing cow 🐮",
+    description="""I'm a cow that likes to moo.
 
 I also serve as an example for the RoboHerd python tool.
 See <a href="https://codeberg.org/helge/roboherd">codeberg.org</a>.""",
-        meta_information=meta_information,
-    )
+    meta_information=meta_information,
 )
 
 

roboherd/examples/number.py

@@ -3,10 +3,7 @@ from urllib.parse import urlparse
 
 from almabtrieb import Almabtrieb
 
-from roboherd.cow import RoboCow
-from roboherd.annotations import PublishObject
-from roboherd.annotations.bovine import ObjectFactory
-from roboherd.cow.types import Information
+from roboherd import RoboCow, PublishObject, ObjectFactory
 from .meta import meta_information
 
 
@@ -14,14 +11,12 @@ def hostname(actor_id):
     return urlparse(actor_id).netloc
 
 
-bot = RoboCow(
-    information=Information(
-        handle="even",
-        description="""<p>I'm a bot by Helge. I post a random number every hour. When posting an even number, I change my Fediverse handle to even. When posting an odd one, I use odd.</p>
+bot = RoboCow.create(
+    handle="even",
+    description="""<p>I'm a bot by Helge. I post a random number every hour. When posting an even number, I change my Fediverse handle to even. When posting an odd one, I use odd.</p>
 
 <p>I also update my name. I'm not sure how you should display my handle with your Fediverse application. Please write a FEP explaining it.</p>""",
-        meta_information=meta_information,
-    )
+    meta_information=meta_information,
 )
 
 

roboherd/examples/rooster.py

@@ -1,17 +1,11 @@
-from roboherd.cow import RoboCow
-from roboherd.cow.types import Information
-
-from roboherd.annotations import PublishObject
-from roboherd.annotations.bovine import ObjectFactory
+from roboherd import RoboCow, PublishObject, ObjectFactory
 
 from .meta import meta_information
 
-bot = RoboCow(
-    information=Information(
-        handle="rooster",
-        name="The crowing rooster 🐓",
-        meta_information=meta_information,
-    )
+bot = RoboCow.create(
+    handle="rooster",
+    name="The crowing rooster 🐓",
+    meta_information=meta_information,
 )
 
 

roboherd/examples/scarecrow.py

@@ -1,22 +1,23 @@
-from roboherd.cow import RoboCow
-from roboherd.cow.types import Information
+from roboherd import RoboCow, MarkdownPoster
 
-from roboherd.annotations import PublishObject
-from roboherd.annotations.bovine import ObjectFactory
+# from roboherd import PublishObject, ObjectFactory
 
 from .meta import meta_information
 
-bot = RoboCow(
-    information=Information(
-        name="The scare crow 👩‍🌾",
-        description="""On startup I scare crows""",
-        handle="scarecrow",
-        meta_information=meta_information,
-    )
+bot = RoboCow.create(
+    name="The scare crow 👩‍🌾",
+    description="""On startup I scare crows""",
+    handle="scarecrow",
+    meta_information=meta_information,
 )
 
 
+# @bot.startup
+# 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(publish_object: PublishObject, object_factory: ObjectFactory):
-    note = object_factory.note(content="Booo! 🐦").as_public().build()  # type: ignore
-    await publish_object(note)
+async def startup(poster: MarkdownPoster):
+    await poster("__Booo!__ 🐦")

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

@@ -1,7 +1,9 @@
 Metadata-Version: 2.4
 Name: roboherd
-Version: 0.1.5
+Version: 0.1.7
 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.7.dist-info}/RECORD

@@ -1,13 +1,13 @@
-roboherd/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+roboherd/__init__.py,sha256=E89YtYyL77iJDJJkHS4Pn0JdTbmkmQS7Cp_XPqpRgx8,533
 roboherd/__main__.py,sha256=cY4f-39QCDhStJ4gDuuSz46RDFE_AKnu08sTCpQEEV4,2933
 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/cow/__init__.py,sha256=MlMvjFbodwZf6vpKlPfIpSn5SHu9IugacSH5ylbySTY,5826
+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=y9NrhXf5ivjfwWBYCqZ0VG1q0gXAYA3_ItfPYWf1qiw,6102
 roboherd/cow/const.py,sha256=fj5nUJUIlcpr1AU2Ur55ToR7iVmYv4UnfdxiQwguv-k,166
 roboherd/cow/handlers.py,sha256=k5Tc1M--wqmZ2EZvzIfID4dp8XE0rN18puMTKkNVjjE,1491
 roboherd/cow/profile.py,sha256=ldeYq50lh97dl50QjOZiGopEbXtCoEsE5QJoXB5XUYU,3330
@@ -18,13 +18,13 @@ roboherd/cow/test_util.py,sha256=8FLRtVdSMmIo6NSpCpB9mS0PwOCpGgUeDAA1q6Gv0P4,430
 roboherd/cow/types.py,sha256=TGXTcPuND7xMly3xFXZyIR7UE3XWyF_MLRuBHWKoFEE,1925
 roboherd/cow/util.py,sha256=ASQn7AnSl5lskECqCyqOKn5BYC8yOces4FK3uNV8010,534
 roboherd/examples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-roboherd/examples/dev_null.py,sha256=6SZ9wlcawSBqhdq6Zv4xPXH5eKH2g1VaRwv3hSCDucE,308
-roboherd/examples/json_echo.py,sha256=EFqNwaSKs0hTQjKZVatjn6i3O7rQff2GTHnEfpL1ha0,1370
+roboherd/examples/dev_null.py,sha256=P2_tVh5Y6Cm7A0FQzX7lRaBlXZZqBsia89Jnoa-s5ek,217
+roboherd/examples/json_echo.py,sha256=TB7sdshsTj7KKOxIc1DzkGeacA9JmIOhNOHwGzyRrVY,1208
 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/moocow.py,sha256=2bZ8oZOpysuf7l3DP3zM4YiaALQHFbWpbP3h_Xlok6E,974
+roboherd/examples/number.py,sha256=c4zALxrKR5POuAUTmzAF4wHVgXMPfrP736N7dgn4xzo,1845
+roboherd/examples/rooster.py,sha256=E-bqm8AKy_EOzptaH6xrlc5eDE8o9SBhfdNqHpEhUb4,437
+roboherd/examples/scarecrow.py,sha256=jUnBaDJ2w9LQNIJAAfA53oJyRvKPJoKHtvHbeW-Pex0,626
 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.7.dist-info/METADATA,sha256=P95nbFNriZRL6yiODXxuMas9mOQjk8i8PrWYEukG2ug,1007
+roboherd-0.1.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+roboherd-0.1.7.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
+roboherd-0.1.7.dist-info/RECORD,,