roboherd 0.1.6__py3-none-any.whl → 0.1.8__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/cow/__init__.py

@@ -76,11 +76,26 @@ class RoboCow:
         ),
     )
 
+    skip_profile_update: bool = field(
+        default=False,
+        metadata=dict(
+            description="When set to True the profile is not updated automatically. Useful when managing a cow from multiple scripts."
+        ),
+    )
+
     internals: RoboCowInternals = field(
         default_factory=RoboCowInternals,
         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.
 
@@ -158,19 +173,6 @@ class RoboCow:
 
         self.internals.startup_routine = func
 
-    def needs_update(self):
-        """Checks if the cow needs to be updated"""
-        if self.internals.profile is None:
-            return True
-
-        if self.information.name != self.internals.profile.get("name"):
-            return True
-
-        if self.information.description != self.internals.profile.get("summary"):
-            return True
-
-        return False
-
     async def run_startup(self, connection: Almabtrieb):
         """Runs when the cow is birthed"""
 
@@ -190,12 +192,8 @@ class RoboCow:
             )
             self.information.frequency = frequency
 
-        update = determine_profile_update(self.information, self.internals.profile)
-
-        if update:
-            logger.info("Updating profile for %s", self.information.handle)
-
-            await connection.trigger("update_actor", update)
+        if not self.skip_profile_update:
+            await self._run_profile_update(connection)
 
         if self.internals.startup_routine:
             await inject(self.internals.startup_routine)(
@@ -203,3 +201,14 @@ class RoboCow:
                 connection=connection,  # type:ignore
                 actor_id=self.internals.actor_id,  # type:ignore
             )  # type:ignore
+
+    async def _run_profile_update(self, connection: Almabtrieb):
+        if self.internals.profile is None:
+            raise ValueError("Profile is not set")
+
+        update = determine_profile_update(self.information, self.internals.profile)
+
+        if update:
+            logger.info("Updating profile for %s", self.information.handle)
+
+            await connection.trigger("update_actor", update)

roboherd/cow/test_init.py

@@ -1,38 +1,9 @@
-import pytest
 from unittest.mock import AsyncMock
 
 from . import RoboCow
 from .types import Information
 
 
-@pytest.mark.parametrize(
-    "name,summary,profile,expected",
-    [
-        ("moocow", None, None, True),
-        ("moocow", None, {"id": "123"}, True),
-        ("moocow", None, {"id": "123", "name": "moocow"}, False),
-        ("moocow", None, {"id": "123", "name": "other"}, True),
-        ("moocow", "description", {"id": "123", "name": "moocow"}, True),
-        (
-            "moocow",
-            "description",
-            {"id": "123", "name": "moocow", "summary": "description"},
-            False,
-        ),
-    ],
-)
-def test_needs_update(name, summary, profile, expected):
-    info = Information(
-        handle="testcow",
-        name=name,
-        description=summary,
-    )
-    cow = RoboCow(information=info)
-    cow.internals.profile = profile
-
-    assert cow.needs_update() == expected
-
-
 def test_cron():
     info = Information(handle="testcow")
     cow = RoboCow(information=info)
@@ -49,9 +20,22 @@ async def test_startup():
     cow = RoboCow(information=info)
     cow.internals.profile = {"id": "http://host.test/actor/cow"}
     mock = AsyncMock()
+    connection = AsyncMock()
 
     cow.startup(mock)
 
-    await cow.run_startup(AsyncMock())
+    await cow.run_startup(connection=connection)
 
     mock.assert_called_once()
+    connection.trigger.assert_awaited_once()
+
+
+async def test_skip_startup():
+    info = Information(handle="testcow")
+    cow = RoboCow(information=info, skip_profile_update=True)
+    cow.internals.profile = {"id": "http://host.test/actor/cow"}
+
+    connection = AsyncMock()
+    await cow.run_startup(connection=connection)
+
+    connection.trigger.assert_not_awaited()

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,27 +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)
 
 
-# @bot.startup
-# async def startup(poster: MarkdownPoster):
-#     await poster("__Booo!__ 🐦")
+@bot.startup
+async def startup(poster: MarkdownPoster):
+    await poster("__Booo!__ 🐦")

roboherd/herd/manager/config.py

@@ -1,9 +1,32 @@
+from pydantic import BaseModel, Field
+
 from dataclasses import dataclass, field
 
 from roboherd.cow import RoboCow
 from .load import load_cow
 
 
+class ConfigOverrides(BaseModel):
+    """Values used in `roboherd.toml` to overide the default
+    values in the imported cow. This class is meant as a
+    reference, and not meant to be directly used."""
+
+    name: str | None = Field(
+        default=None, description="set to override the name", examples=["New name"]
+    )
+    handle: str | None = Field(
+        default=None, description="set to override the handle", examples=["new-handle"]
+    )
+    base_url: str | None = Field(
+        default=None,
+        description="set to override the base url",
+        examples=["https://other.example"],
+    )
+    skip_profile_update: bool | None = Field(
+        default=None, description="set to skip updating the profile", examples=[True]
+    )
+
+
 @dataclass
 class CowConfig:
     name: str = field(metadata={"description": "Name of the cow, must be unique"})
@@ -20,13 +43,14 @@ class CowConfig:
     def load(self) -> RoboCow:
         cow = load_cow(self.module, self.attribute)
 
-        if "name" in self.config:
-            cow.information.name = self.config["name"]
-        if "handle" in self.config:
-            cow.information.handle = self.config["handle"]
+        overrides = ConfigOverrides(**self.config)
+
+        for value in ["name", "handle", "base_url"]:
+            if getattr(overrides, value):
+                setattr(cow.information, value, getattr(overrides, value))
 
-        if "base_url" in self.config:
-            cow.internals.base_url = self.config["base_url"]
+        if overrides.skip_profile_update:
+            cow.skip_profile_update = overrides.skip_profile_update
 
         return cow
 

roboherd/herd/manager/test_config.py

@@ -44,6 +44,7 @@ def test_from_name_and_dict_with_new_name():
         "bot": "roboherd.examples.moocow:moocow",
         "handle": "new_handle",
         "name": "new name",
+        "skip_profile_update": True,
     }
 
     config = CowConfig.from_name_and_dict(name, value)
@@ -52,6 +53,7 @@ def test_from_name_and_dict_with_new_name():
 
     assert cow.information.name == "new name"
     assert cow.information.handle == "new_handle"
+    assert cow.skip_profile_update is True
 
 
 def test_load_config(test_config):

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: roboherd
-Version: 0.1.6
+Version: 0.1.8
 Summary: A Fediverse bot framework
 Project-URL: Documentation, https://bovine.codeberg.page/roboherd/
 Project-URL: Repository, https://codeberg.org/bovine/roboherd

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

@@ -1,4 +1,4 @@
-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
@@ -7,24 +7,24 @@ roboherd/validators.py,sha256=2mc43ZGwFazp4f3B9J4RxZCU4Y_ErSNotib8MnYVtmY,140
 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/__init__.py,sha256=wSfYordSLmn3azxWkZs36h3ipbS6NdPh9kAWyyg0NIU,6223
 roboherd/cow/const.py,sha256=fj5nUJUIlcpr1AU2Ur55ToR7iVmYv4UnfdxiQwguv-k,166
 roboherd/cow/handlers.py,sha256=k5Tc1M--wqmZ2EZvzIfID4dp8XE0rN18puMTKkNVjjE,1491
 roboherd/cow/profile.py,sha256=ldeYq50lh97dl50QjOZiGopEbXtCoEsE5QJoXB5XUYU,3330
 roboherd/cow/test_handlers.py,sha256=SwrZZcU_BD2BpJUFg18mFEsyUqu7N81-MkjIaGv7whQ,1673
-roboherd/cow/test_init.py,sha256=bnK8IIbbeS1Y7vJaFg5HzCL6UoZeCl6mo_SAQqJAgQY,1409
+roboherd/cow/test_init.py,sha256=GrOFyEKbvkddrUQM7B0RFelNLc_rmdlxU_8C-DjoUh8,999
 roboherd/cow/test_profile.py,sha256=f7HE0iVgbpuNv6znEqi-4l1o_8UZ9ufQpjSVP7Xf1wc,2160
 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=CgQuI7smKBJdeMiL8fY5SP1itH5GaFRAoX3I3QGF3rw,748
+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
@@ -33,12 +33,12 @@ roboherd/herd/test_herd.py,sha256=sQkzGCWdFveLklhaOJUybtl7odO-QOSDdd-_gan1py8,84
 roboherd/herd/test_scheduler.py,sha256=wLisqRMSl734P_rjbqMNH5WTQKepwihgr7ZC32nEj80,424
 roboherd/herd/types.py,sha256=_EidQbglm0jpsKX1EsL6U2qm_J5wCPhwUi6Avac22Ow,210
 roboherd/herd/manager/__init__.py,sha256=NqOJsp1CdAobjARJGmzvU1ceTW7j2bt0FdRbpM8iFUw,1464
-roboherd/herd/manager/config.py,sha256=VDuxB7GMoZdgSM2i1iG1o-IjtyScsSnO--6PEM8tx9U,1591
+roboherd/herd/manager/config.py,sha256=8m-313_wn_-b4ivPSoPyyTQh0ONNLcd-Zz3pgWh8p1c,2429
 roboherd/herd/manager/load.py,sha256=BoeBID2UGP--sIKwITABQkQv2lMc9Y8pyp7_nleu2bw,351
-roboherd/herd/manager/test_config.py,sha256=CnoqQ_exrpQdBWVoGxSns3HpccqgmhH9mNJIPTCKKAs,1665
+roboherd/herd/manager/test_config.py,sha256=I2EP7nEUdBVO8Wqot7SRhzp5UZFr5oGIuFS7cNB2iFk,1745
 roboherd/herd/manager/test_load.py,sha256=zyu5LIChMfTnxu_tYK63-bSOHYn1K1zUlbDY5DkE3GY,514
 roboherd/herd/manager/test_manager.py,sha256=9pSMaH7zmN-zagYCIBpQcV3Q0sBT7XZSCvsmLVC0rOI,1047
-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,,
+roboherd-0.1.8.dist-info/METADATA,sha256=SoBEuuNWN1AYoDfom7330kaSYHcKYTzfIARF0FqE4NM,1007
+roboherd-0.1.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+roboherd-0.1.8.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
+roboherd-0.1.8.dist-info/RECORD,,