roboherd 0.1.6__tar.gz → 0.1.8__tar.gz

{roboherd-0.1.6 → roboherd-0.1.8}/.woodpecker/test.yml

@@ -31,6 +31,7 @@ steps:
   build_docs:
     image: ghcr.io/astral-sh/uv:python3.11-alpine
     commands:
+      - cp CHANGES.md docs/CHANGES.md
       - uv run mkdocs build
     when:
       - matrix: { extras: "--all-extras" }

{roboherd-0.1.6 → roboherd-0.1.8}/.woodpecker/website.yml

@@ -7,6 +7,7 @@ steps:
     image: ghcr.io/astral-sh/uv:python3.11-alpine
     commands:
       - uv sync --all-extras
+      - cp CHANGES.md docs/CHANGES.md
       - uv run mkdocs build
   deploy:
     image: codeberg.org/xfix/plugin-codeberg-pages-deploy:1

{roboherd-0.1.6 → roboherd-0.1.8}/CHANGES.md

@@ -1,5 +1,15 @@
 # Changes to roboherd
 
+## 0.1.8 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/11129))
+
+- Add ConfigOverrides model [roboherd#43](https://codeberg.org/bovine/roboherd/issues/43)
+- Allow to skip startup [roboherd#41](https://codeberg.org/bovine/roboherd/issues/41)
+
+## 0.1.7 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/10741))
+
+- Repair docker file [roboherd#38](https://codeberg.org/bovine/roboherd/issues/38)
+- Simplify imports and creating a RoboCow [roboherd#39](https://codeberg.org/bovine/roboherd/issues/39)
+
 ## 0.1.6 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/10694))
 
 - Comment on python path [roboherd#34](https://codeberg.org/bovine/roboherd/issues/34)

{roboherd-0.1.6 → roboherd-0.1.8}/PKG-INFO

@@ -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 → roboherd-0.1.8}/docs/index.md

@@ -122,7 +122,7 @@ handle = "nothingness"
 ```
 
 one would instead create a bot with the handle `acct:nothingness@dev.bovine.social`.
-Similarly, one can override the name and the `base_url` to use.
+The full list of options can be found in [roboherd.herd.manager.config.ConfigOverrides][].
 
 ### Posting on startup
 

roboherd-0.1.8/docs/main.md

@@ -0,0 +1,3 @@
+:::roboherd
+    options:
+        show_submodules: false

{roboherd-0.1.6 → roboherd-0.1.8}/mkdocs.yml

@@ -59,8 +59,10 @@ plugins:
               - griffe_fieldz: { include_inherited: true }
 nav:
   - Home: index.md
+  - "Changes": CHANGES.md
   - "Commang Line Tool": cli.md
   - "References":
+      - "roboherd": main.md
       - "roboherd.annotations": annotations.md
       - "roboherd.cow": cow.md
       - "roboherd.herd": herd.md

{roboherd-0.1.6 → roboherd-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "roboherd"
-version = "0.1.6"
+version = "0.1.8"
 description = "A Fediverse bot framework"
 readme = "README.md"
 requires-python = ">=3.11"

{roboherd-0.1.6 → roboherd-0.1.8}/resources/docker/Dockerfile

@@ -1,7 +1,7 @@
 FROM helgekr/bovine:0.5.18-python3.13
 
-ARG tag
-RUN pip install roboherd==${tag}
+ARG tag=0.1.6
+RUN pip install roboherd[bovine]==${tag}
 
 RUN mkdir /app
 WORKDIR /app

roboherd-0.1.8/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-0.1.6 → roboherd-0.1.8}/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-0.1.8/roboherd/cow/test_init.py

@@ -0,0 +1,41 @@
+from unittest.mock import AsyncMock
+
+from . import RoboCow
+from .types import Information
+
+
+def test_cron():
+    info = Information(handle="testcow")
+    cow = RoboCow(information=info)
+
+    @cow.cron("* * * * *")
+    async def test_func():
+        pass
+
+    assert len(cow.internals.cron_entries) == 1
+
+
+async def test_startup():
+    info = Information(handle="testcow")
+    cow = RoboCow(information=info)
+    cow.internals.profile = {"id": "http://host.test/actor/cow"}
+    mock = AsyncMock()
+    connection = AsyncMock()
+
+    cow.startup(mock)
+
+    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-0.1.8/roboherd/examples/dev_null.py

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

{roboherd-0.1.6 → roboherd-0.1.8}/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-0.1.6 → roboherd-0.1.8}/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-0.1.6 → roboherd-0.1.8}/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-0.1.8/roboherd/examples/rooster.py

@@ -0,0 +1,16 @@
+from roboherd import RoboCow, PublishObject, ObjectFactory
+
+from .meta import meta_information
+
+bot = RoboCow.create(
+    handle="rooster",
+    name="The crowing rooster 🐓",
+    meta_information=meta_information,
+)
+
+
+@bot.cron("42 * * * *")
+async def crow(publisher: PublishObject, object_factory: ObjectFactory):
+    await publisher(
+        object_factory.note(content="cock-a-doodle-doo").as_public().build()  # type: ignore
+    )

roboherd-0.1.8/roboherd/examples/scarecrow.py

@@ -0,0 +1,23 @@
+from roboherd import RoboCow, MarkdownPoster
+
+# from roboherd import PublishObject, ObjectFactory
+
+from .meta import 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(poster: MarkdownPoster):
+    await poster("__Booo!__ 🐦")

{roboherd-0.1.6 → roboherd-0.1.8}/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-0.1.6 → roboherd-0.1.8}/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 → roboherd-0.1.8}/uv.lock

@@ -15,11 +15,11 @@ wheels = [
 
 [[package]]
 name = "aiohappyeyeballs"
-version = "2.4.6"
+version = "2.4.8"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/08/07/508f9ebba367fc3370162e53a3cfd12f5652ad79f0e0bfdf9f9847c6f159/aiohappyeyeballs-2.4.6.tar.gz", hash = "sha256:9b05052f9042985d32ecbe4b59a77ae19c006a78f1344d7fdad69d28ded3d0b0", size = 21726 }
+sdist = { url = "https://files.pythonhosted.org/packages/de/7c/79a15272e88d2563c9d63599fa59f05778975f35b255bf8f90c8b12b4ada/aiohappyeyeballs-2.4.8.tar.gz", hash = "sha256:19728772cb12263077982d2f55453babd8bec6a052a926cd5c0c42796da8bf62", size = 22337 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/44/4c/03fb05f56551828ec67ceb3665e5dc51638042d204983a03b0a1541475b6/aiohappyeyeballs-2.4.6-py3-none-any.whl", hash = "sha256:147ec992cf873d74f5062644332c539fcd42956dc69453fe5204195e560517e1", size = 14543 },
+    { url = "https://files.pythonhosted.org/packages/52/0e/b187e2bb3eeb2644515109657c4474d65a84e7123de249bf1e8467d04a65/aiohappyeyeballs-2.4.8-py3-none-any.whl", hash = "sha256:6cac4f5dd6e34a9644e69cf9021ef679e4394f54e58a183056d12009e42ea9e3", size = 15005 },
 ]
 
 [[package]]
@@ -1363,7 +1363,7 @@ wheels = [
 
 [[package]]
 name = "roboherd"
-version = "0.1.6"
+version = "0.1.8"
 source = { editable = "." }
 dependencies = [
     { name = "aiohttp" },

roboherd-0.1.6/roboherd/cow/test_init.py

@@ -1,57 +0,0 @@
-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)
-
-    @cow.cron("* * * * *")
-    async def test_func():
-        pass
-
-    assert len(cow.internals.cron_entries) == 1
-
-
-async def test_startup():
-    info = Information(handle="testcow")
-    cow = RoboCow(information=info)
-    cow.internals.profile = {"id": "http://host.test/actor/cow"}
-    mock = AsyncMock()
-
-    cow.startup(mock)
-
-    await cow.run_startup(AsyncMock())
-
-    mock.assert_called_once()

roboherd-0.1.6/roboherd/examples/dev_null.py

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

roboherd-0.1.6/roboherd/examples/rooster.py

@@ -1,22 +0,0 @@
-from roboherd.cow import RoboCow
-from roboherd.cow.types import Information
-
-from roboherd.annotations import PublishObject
-from roboherd.annotations.bovine import ObjectFactory
-
-from .meta import meta_information
-
-bot = RoboCow(
-    information=Information(
-        handle="rooster",
-        name="The crowing rooster 🐓",
-        meta_information=meta_information,
-    )
-)
-
-
-@bot.cron("42 * * * *")
-async def crow(publisher: PublishObject, object_factory: ObjectFactory):
-    await publisher(
-        object_factory.note(content="cock-a-doodle-doo").as_public().build()  # type: ignore
-    )

roboherd-0.1.6/roboherd/examples/scarecrow.py

@@ -1,27 +0,0 @@
-from roboherd.cow import RoboCow
-from roboherd.cow.types import Information
-
-from roboherd.annotations import PublishObject
-from roboherd.annotations.bovine import 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.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!__ 🐦")