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

roboherd/__main__.py

@@ -13,6 +13,7 @@ from roboherd.register import register as run_register
 from roboherd.validators import validators
 
 logging.basicConfig(level=logging.INFO)
+logging.captureWarnings(True)
 
 
 @click.group()

roboherd/cow/__init__.py

@@ -76,6 +76,13 @@ 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"),
@@ -166,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"""
 
@@ -198,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)(
@@ -211,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/rooster.py

@@ -5,6 +5,7 @@ from .meta import meta_information
 bot = RoboCow.create(
     handle="rooster",
     name="The crowing rooster 🐓",
+    description="I'm a rooster that crows at a set frequency.",
     meta_information=meta_information,
 )
 

roboherd/herd/__init__.py

@@ -63,6 +63,8 @@ class RoboHerd:
             scheduler = HerdScheduler(self.cron_entries(), connection)
             scheduler.create_task(tg)
 
+            connection.add_on_disconnect(scheduler.stop)
+
     def validate(self, connection):
         result = connection.information
 

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/herd/processor.py

@@ -28,12 +28,15 @@ class HerdProcessor:
         for cow in self.incoming_handlers:
             actor_id_to_cow_map[cow.internals.actor_id] = cow
 
+        logger.info("Incoming processing started for %s cows", len(actor_id_to_cow_map))
+
         async for msg in connection.incoming():
             actor_id = msg["actor"]
 
             cow = actor_id_to_cow_map.get(actor_id)
-            logger.info(cow)
             if cow:
                 await cow.internals.handlers.handle(
                     msg, "incoming", connection, actor_id, cow=cow
                 )
+
+        logger.warning("Process incoming ended")

roboherd/herd/scheduler.py

@@ -19,22 +19,30 @@ logger = logging.getLogger(__name__)
 class HerdScheduler:
     entries: List[Tuple[RoboCow, CronEntry]]
     connection: Almabtrieb
+    scheduler: AsyncIOScheduler | None = None
+    task: asyncio.Task | None = None
 
     def create_task(self, task_group: asyncio.TaskGroup):
         if len(self.entries) == 0:
             logger.info("No tasks to schedule")
             return
-        task_group.create_task(self.run())
+        if self.task:
+            raise Exception("Task already running")
+
+        self.task = task_group.create_task(self.run())
 
     async def run(self):
         if len(self.entries) == 0:
             return
 
-        scheduler = AsyncIOScheduler()
+        if self.scheduler:
+            raise Exception("Scheduler already exists")
+
+        self.scheduler = AsyncIOScheduler()
 
         for cow, entry in self.entries:
             trigger = CronTrigger.from_crontab(entry.crontab)
-            scheduler.add_job(
+            self.scheduler.add_job(
                 inject(entry.func),
                 trigger=trigger,
                 kwargs={
@@ -44,7 +52,14 @@ class HerdScheduler:
                 },
             )
 
-        scheduler.start()
+        self.scheduler.start()
 
         while True:
             await asyncio.sleep(60 * 60)
+
+    async def stop(self):
+        logger.warning("Stopping scheduler")
+        if self.scheduler:
+            self.scheduler.shutdown()
+        if self.task:
+            self.task.cancel()

roboherd-0.1.9.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: roboherd
+Version: 0.1.9
+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.2
+Requires-Dist: apscheduler>=3.11.0
+Requires-Dist: click>=8.1.8
+Requires-Dist: cron-descriptor>=1.4.5
+Requires-Dist: dynaconf>=3.2.6
+Requires-Dist: fast-depends>=2.4.12
+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 is a framework for building Fediverse bots
+using the [Cattle Drive Protocol](https://bovine.codeberg.page/cattle_grid/cattle_drive/).
+
+For more information, see the [documentation](https://bovine.codeberg.page/roboherd/) or the [repository](https://codeberg.org/bovine/roboherd/).
+
+## Developping with cattle_grid
+
+In your catle_grid `config` directory add a roboherd user, e.g.
+a file `testing.toml` with content
+
+```toml
+[testing]
+enable = true
+
+[[testing.accounts]]
+name = "herd"
+password = "pass"
+permissions = ["admin"]
+```
+
+Configure roboherd via `roboherd.toml`, e.g.
+
+```toml
+base_url = "http://abel"
+connection_string = "ws://herd:pass@localhost:3000/ws/"
+
+[cow.rooster]
+bot = "roboherd.examples.rooster:bot"
+```
+
+This will trigger a periodic message to cattle_grid.
+
+### nginx for cattle_grid
+
+The nginx in the `cattle_grid` configuration should forward the path `/ws/` to
+rabbitmq (supporting mqtt over websockets)
+
+```nginx
+server {
+    listen 80;
+    
+    location /ws/ {
+        proxy_pass http://rabbitmq:15675;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection $connection_upgrade;
+        proxy_read_timeout 86400; # neccessary to avoid websocket timeout disconnect
+        proxy_send_timeout 86400; # neccessary to avoid websocket timeout disconnect
+        proxy_redirect off;
+        proxy_buffering off;
+    }
+}
+```
+
+similarly `nginx` should forward port 80 to 3000 (in the docker compose file).

{roboherd-0.1.7.dist-info → roboherd-0.1.9.dist-info}/RECORD

@@ -1,5 +1,5 @@
 roboherd/__init__.py,sha256=E89YtYyL77iJDJJkHS4Pn0JdTbmkmQS7Cp_XPqpRgx8,533
-roboherd/__main__.py,sha256=cY4f-39QCDhStJ4gDuuSz46RDFE_AKnu08sTCpQEEV4,2933
+roboherd/__main__.py,sha256=DMsxzSdO_tN0RazYcJicF1eZZzWT7NAYg3jXi7kEuU8,2963
 roboherd/register.py,sha256=Gqa5aT2supVJMj7z21btMYRma3_WW0oK5gjZftr048s,976
 roboherd/test_validators.py,sha256=UiFgJkutmXBLjGpdLP2IBYCEf75quwnRHX7Z51G8Xqo,222
 roboherd/util.py,sha256=nrFRtyfvMQ8oXoGDYxmCAXcIN14dWBAPGv0cI_B_TP0,1710
@@ -7,12 +7,12 @@ 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=y9NrhXf5ivjfwWBYCqZ0VG1q0gXAYA3_ItfPYWf1qiw,6102
+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
@@ -23,22 +23,22 @@ roboherd/examples/json_echo.py,sha256=TB7sdshsTj7KKOxIc1DzkGeacA9JmIOhNOHwGzyRrV
 roboherd/examples/meta.py,sha256=tFhHe-DJn2J13Mm22f-gFm5I8_3uQwLU4mAkrK2xzEM,170
 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/rooster.py,sha256=ItPBpxhz72agkzFf13nv6csYVUJCZRabtUaGyKwUKRg,501
 roboherd/examples/scarecrow.py,sha256=jUnBaDJ2w9LQNIJAAfA53oJyRvKPJoKHtvHbeW-Pex0,626
-roboherd/herd/__init__.py,sha256=6jWgYnuJOpXtYS03mdjEgWd0zXv5kj9w9d7K6UsCPbc,3068
+roboherd/herd/__init__.py,sha256=AtmpzoIbJwX82cx-9GdYMYQ5guj2vWb1dVYNGc1PReo,3126
 roboherd/herd/builder.py,sha256=MSVPRF0Jsxure9kdyCoYJHQ7nYilGAD0_uQaGQ-rQyE,619
-roboherd/herd/processor.py,sha256=ncXsYfuTRTT_0-K453COF_oAiGBJN0u5eP8NoeZmWik,1042
-roboherd/herd/scheduler.py,sha256=pbWxOo9pnjAoAJhbvaczmSghkp6Y8Zp2HgXZ5zoOnDA,1276
+roboherd/herd/processor.py,sha256=4wZUp4xND9ZhxLIedUN7Yu3jxKWuuFqJent7wRiaAE0,1153
+roboherd/herd/scheduler.py,sha256=4zAPJkWs1ZGHlwTweHdhYb5xrHnpiSTpTEQ64drA-oE,1735
 roboherd/herd/test_herd.py,sha256=sQkzGCWdFveLklhaOJUybtl7odO-QOSDdd-_gan1py8,845
 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.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,,
+roboherd-0.1.9.dist-info/METADATA,sha256=OPELZHKFq-g1XS1XqUzyvhE6ygMyTutw4YshGFpW3_8,2205
+roboherd-0.1.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+roboherd-0.1.9.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
+roboherd-0.1.9.dist-info/RECORD,,

roboherd-0.1.7.dist-info/METADATA

@@ -1,27 +0,0 @@
-Metadata-Version: 2.4
-Name: roboherd
-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
-Requires-Dist: apscheduler>=3.11.0
-Requires-Dist: click>=8.1.8
-Requires-Dist: cron-descriptor>=1.4.5
-Requires-Dist: dynaconf>=3.2.6
-Requires-Dist: fast-depends>=2.4.12
-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 is a framework for building Fediverse bots
-using the [Cattle Drive Protocol](https://bovine.codeberg.page/cattle_grid/cattle_drive/).
-
-For more information, see the [documentation](https://bovine.codeberg.page/roboherd/) or the [repository](https://codeberg.org/bovine/roboherd/).