roboherd 0.1.2__tar.gz → 0.1.4__tar.gz

{roboherd-0.1.2 → roboherd-0.1.4}/.woodpecker/create_release.yml

@@ -7,6 +7,7 @@ depends_on: ["test"]
 steps:
   create_release:
     image: helgekr/release_helper
+    pull: true
     environment:
       CODEBERG_TOKEN: { from_secret: codeberg_token }
       CODEBERG_OWNER: bovine

{roboherd-0.1.2 → roboherd-0.1.4}/.woodpecker/test.yml

@@ -2,11 +2,14 @@ when:
   - branch: [main]
     event: [pull_request, push]
 
+matrix:
+  extras: ["--all-extras", ""]
+
 steps:
   build:
     image: ghcr.io/astral-sh/uv:python3.11-alpine
     commands:
-      - uv sync --all-extras
+      - uv sync ${extras}
   test_format:
     image: ghcr.io/astral-sh/uv:python3.11-alpine
     commands:
@@ -16,7 +19,16 @@ steps:
     image: ghcr.io/astral-sh/uv:python3.11-alpine
     commands:
       - uv run pytest
+  test_typing:
+    image: ghcr.io/astral-sh/uv:python3.11-alpine
+    commands:
+      - apk add libstdc++ libgcc
+      - uv run pyright roboherd
+    when:
+      - matrix: { extras: "--all-extras" }
   build_docs:
     image: ghcr.io/astral-sh/uv:python3.11-alpine
     commands:
       - uv run mkdocs build
+    when:
+      - matrix: { extras: "--all-extras" }

{roboherd-0.1.2 → roboherd-0.1.4}/CHANGES.md

@@ -1,5 +1,16 @@
 # Changes to roboherd
 
+## 0.1.4 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/10442))
+
+- Type check the project
+- No longer require bovine [roboherd#26](https://codeberg.org/bovine/roboherd/issues/26)
+- Fixed typo in Dockerfile [roboherd#28](https://codeberg.org/bovine/roboherd/issues/28)
+
+## 0.1.3 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/10441))
+
+- Add information about developement [roboherd#24](https://codeberg.org/bovine/roboherd/issues/24)
+- Repair docker build [roboherd#23](https://codeberg.org/bovine/roboherd/issues/23)
+
 ## 0.1.1 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/10245))
 
 - Document environment variable overrides [roboherd#16](https://codeberg.org/bovine/roboherd/issues/16)

{roboherd-0.1.2 → roboherd-0.1.4}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: roboherd
-Version: 0.1.2
+Version: 0.1.4
 Summary: A Fediverse bot framework
 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

{roboherd-0.1.2 → roboherd-0.1.4}/docs/index.md

@@ -295,3 +295,30 @@ the appropriate points in the menu on the left.
 The console also allows you to lookup Fediverse
 objects as seen through cattle_grid and perform actions
 manually.
+
+## Developing roboherd
+
+Roboherd uses [astral-uv](https://docs.astral.sh/uv/) and
+[hatch](https://hatch.pypa.io/latest/) for development. After
+cloning the repository, run
+
+```bash
+uv sync --all-extras
+```
+
+to install dependencies using uv. Then one can run tests via
+
+```bash
+uv run pytest
+uv run ruff check .
+uv run ruff format .
+```
+
+### Releasing
+
+Releases, packages, documentation, and docker containers are
+build automatically using the CI. For this increase the
+version, have a [milestone](https://codeberg.org/bovine/roboherd/milestones)
+matching the new version, and appropriate entries in
+`CHANGES.md`. Then once a pull request with this is merged,
+the rest happens automatically.

{roboherd-0.1.2 → roboherd-0.1.4}/pyproject.toml

@@ -1,10 +1,11 @@
 [project]
 name = "roboherd"
-version = "0.1.2"
+version = "0.1.4"
 description = "A Fediverse bot framework"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
+    "aiohttp>=3.11.12",
     "almabtrieb[mqtt]>=0.1.0a1",
     "apscheduler>=3.11.0",
     "click>=8.1.8",
@@ -37,6 +38,7 @@ dev-dependencies = [
     "griffe-fieldz>=0.2.1",
     "mkdocs-click>=0.8.1",
     "ruff>=0.9.6",
+    "pyright>=1.1.394",
 ]
 
 [tool.pytest.ini_options]

{roboherd-0.1.2 → roboherd-0.1.4}/resources/docker/Dockerfile

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

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/__main__.py

@@ -10,6 +10,7 @@ from roboherd.herd import RoboHerd
 from roboherd.herd.manager import HerdManager
 from roboherd.util import create_connection
 from roboherd.register import register as run_register
+from roboherd.validators import validators
 
 logging.basicConfig(level=logging.INFO)
 
@@ -32,6 +33,7 @@ def main(ctx, connection_string, base_url, config_file):
     settings = dynaconf.Dynaconf(
         settings_files=[config_file],
         envvar_prefix="ROBOHERD",
+        validators=validators,
     )
     ctx.ensure_object(dict)
 
@@ -41,12 +43,12 @@ def main(ctx, connection_string, base_url, config_file):
     if connection_string:
         ctx.obj["connection_string"] = connection_string
     else:
-        ctx.obj["connection_string"] = settings.get("connection_string")
+        ctx.obj["connection_string"] = settings.connection_string
 
     if base_url:
         ctx.obj["base_url"] = base_url
     else:
-        ctx.obj["base_url"] = settings.get("base_url")
+        ctx.obj["base_url"] = settings.base_url
 
 
 @main.command()

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/annotations/__init__.py

@@ -5,11 +5,11 @@ from almabtrieb import Almabtrieb
 
 
 def get_raw(data: dict) -> dict:
-    return data.get("data").get("raw")
+    return data.get("data", {}).get("raw")
 
 
 def get_parsed(data: dict) -> dict:
-    result = data.get("data").get("parsed")
+    result = data.get("data", {}).get("parsed")
     if result is None:
         raise ValueError("No parsed data found")
     return result
@@ -23,11 +23,17 @@ ParsedData = Annotated[dict, Depends(get_parsed)]
 
 
 def get_activity(parsed: ParsedData) -> dict:
-    return parsed.get("activity")
+    result = parsed.get("activity")
+    if not result:
+        raise ValueError("No activity found")
+    return result
 
 
 def get_embedded_object(parsed: ParsedData) -> dict:
-    return parsed.get("embeddedObject")
+    result = parsed.get("embeddedObject")
+    if not result:
+        raise ValueError("No embedded object found")
+    return result
 
 
 Activity = Annotated[dict, Depends(get_activity)]

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/annotations/bovine.py

@@ -7,19 +7,19 @@ from .common import Profile
 try:
     from bovine.activitystreams import factories_for_actor_object
     from bovine.activitystreams.activity_factory import (
-        ActivityFactory as BovineActivityFactory,
+        ActivityFactory as BovineActivityFactory,  # type: ignore
     )
     from bovine.activitystreams.object_factory import (
-        ObjectFactory as BovineObjectFactory,
+        ObjectFactory as BovineObjectFactory,  # type: ignore
     )
 
-    def get_activity_factory(profile: Profile) -> BovineActivityFactory:
+    def get_activity_factory(profile: Profile) -> BovineActivityFactory:  # type: ignore
         activity_factory, _ = factories_for_actor_object(profile)
-        return activity_factory
+        return activity_factory  # type: ignore
 
-    def get_object_factory(profile: Profile) -> BovineObjectFactory:
+    def get_object_factory(profile: Profile) -> BovineObjectFactory:  # type: ignore
         _, object_factory = factories_for_actor_object(profile)
-        return object_factory
+        return object_factory  # type: ignore
 
 except ImportError:
 
@@ -34,8 +34,8 @@ except ImportError:
         raise ImportError("bovine not installed")
 
 
-ActivityFactory = Annotated[BovineActivityFactory, Depends(get_activity_factory)]
+ActivityFactory = Annotated[BovineActivityFactory, Depends(get_activity_factory)]  # type: ignore
 """The activity factory of type [bovine.activitystreams.activity_factory.ActivityFactory][]"""
 
-ObjectFactory = Annotated[BovineObjectFactory, Depends(get_object_factory)]
+ObjectFactory = Annotated[BovineObjectFactory, Depends(get_object_factory)]  # type: ignore
 """The object factory of type [bovine.activitystreams.object_factory.ObjectFactory][]"""

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/annotations/common.py

@@ -5,6 +5,8 @@ from roboherd.cow import RoboCow
 
 
 def get_profile(cow: RoboCow) -> dict:
+    if cow.profile is None:
+        raise ValueError("Cow has no profile")
     return cow.profile
 
 

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/cow/__init__.py

@@ -187,7 +187,11 @@ class RoboCow:
         """Runs when the cow is birthed"""
 
         if self.profile is None:
+            if not self.actor_id:
+                raise ValueError("Actor ID is not set")
             result = await connection.fetch(self.actor_id, self.actor_id)
+            if not result.data:
+                raise ValueError("Could not retrieve profile")
             self.profile = result.data
 
         if self.cron_entries:

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/cow/profile.py

@@ -1,5 +1,15 @@
 from urllib.parse import urlparse
-from bovine.activitystreams.utils import as_list
+
+try:
+    from bovine.activitystreams.utils import as_list
+except ImportError:
+
+    def as_list(value):
+        if isinstance(value, list):
+            return value
+
+        return [value]
+
 
 from .types import Information
 
@@ -27,7 +37,7 @@ def key_index_from_attachment(attachments: list[dict], key: str) -> int | None:
 
 
 def determine_action_for_key_and_value(
-    attachments: list[dict], key: str, value: str
+    attachments: list[dict], key: str, value: str | None
 ) -> dict | None:
     idx = key_index_from_attachment(attachments, key)
     if idx is None:
@@ -78,19 +88,19 @@ def determine_actions(information: Information, profile: dict) -> list[dict] | N
                 "identifier": "acct:"
                 + information.handle
                 + "@"
-                + urlparse(profile.get("id")).netloc,
+                + str(urlparse(profile.get("id")).netloc),
                 "primary": True,
             }
         )
 
-    actions = list(filter(lambda x: x, actions))
+    actions = [x for x in actions if x is not None]
 
     if len(actions) == 0:
         return None
     return actions
 
 
-def determine_profile_update(information: Information, profile: dict) -> dict:
+def determine_profile_update(information: Information, profile: dict) -> dict | None:
     """Returns the update for the profile"""
 
     update = {"actor": profile.get("id")}

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/cow/types.py

@@ -6,13 +6,13 @@ class MetaInformation(BaseModel):
     information such as the author and the source repository"""
 
     source: str | None = Field(
-        None,
+        default=None,
         examples=["https://forge.example/repo"],
         description="The source repository",
     )
 
     author: str | None = Field(
-        None,
+        default=None,
         examples=["acct:author@domain.example"],
         description="The author, often a Fediverse handle",
     )
@@ -22,23 +22,25 @@ class Information(BaseModel):
     """Information about the cow"""
 
     type: str = Field(
-        "Service", examples=["Service"], description="ActivityPub type of the actor."
+        default="Service",
+        examples=["Service"],
+        description="ActivityPub type of the actor.",
     )
 
     handle: str | None = Field(
-        None,
+        default=None,
         examples=["moocow"],
         description="Used as the handle in `acct:handle@domain.example`",
     )
 
     name: str | None = Field(
-        None,
+        default=None,
         examples=["The mooing cow 🐮"],
         description="The display name of the cow",
     )
 
     description: str | None = Field(
-        None,
+        default=None,
         examples=[
             "I'm a cow that moos.",
             """<p>An example bot to illustrate Roboherd</p><p>For more information on RoboHerd, see <a href="https://codeberg.org/bovine/roboherd">its repository</a>.</p>""",
@@ -47,12 +49,12 @@ class Information(BaseModel):
     )
 
     frequency: str | None = Field(
-        None,
+        default=None,
         examples=["daily"],
         description="Frequency of posting. Is set automatically if cron expressions are used.",
     )
 
     meta_information: MetaInformation = Field(
-        MetaInformation(),
+        default=MetaInformation(),
         description="Meta information about the cow, such as the source repository",
     )

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/cow/util.py

@@ -19,5 +19,8 @@ async def call_handler(
     cow=None,
 ):
     return await inject(handler_info.func)(
-        data=data, connection=connection, actor_id=actor_id, cow=cow
+        data=data,  # type: ignore
+        connection=connection,
+        actor_id=actor_id,
+        cow=cow,
     )

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/examples/json_echo.py

@@ -45,7 +45,7 @@ async def create(
     raw: RawData, publish_object: PublishObject, object_factory: ObjectFactory
 ):
     note = (
-        object_factory.reply(
+        object_factory.reply(  # type: ignore
             raw.get("object"),
             content=reply_content(raw),
         )

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/examples/number.py

@@ -51,7 +51,7 @@ async def post_number(
 ):
     number = random.randint(0, 1000)
 
-    note = factory.note(content=f"Number: {number}").as_public().build()
+    note = factory.note(content=f"Number: {number}").as_public().build()  # type: ignore
     await publisher(note)
 
     handle = "even" if number % 2 == 0 else "odd"

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/examples/rooster.py

@@ -18,5 +18,5 @@ bot = RoboCow(
 @bot.cron("42 * * * *")
 async def crow(publisher: PublishObject, object_factory: ObjectFactory):
     await publisher(
-        object_factory.note(content="cock-a-doodle-doo").as_public().build()
+        object_factory.note(content="cock-a-doodle-doo").as_public().build()  # type: ignore
     )

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/examples/scarecrow.py

@@ -18,4 +18,4 @@ bot = RoboCow(
 
 @bot.startup
 async def startup(publish_object: PublishObject, object_factory: ObjectFactory):
-    await publish_object(object_factory.note(content="Booo! 🐦").as_public().build())
+    await publish_object(object_factory.note(content="Booo! 🐦").as_public().build())  # type: ignore

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/herd/__init__.py

@@ -29,6 +29,9 @@ class RoboHerd:
             await self.process(connection)
 
     async def startup(self, connection: Almabtrieb):
+        if not connection.information:
+            raise Exception("Could not get information from server")
+
         self.cows = self.manager.existing_cows(connection.information.actors)
 
         cows_to_create = self.manager.cows_to_create(connection.information.actors)
@@ -60,9 +63,6 @@ class RoboHerd:
             scheduler = HerdScheduler(self.cron_entries(), connection)
             scheduler.create_task(tg)
 
-    def introduce(self, cow: RoboCow):
-        self.manager.add_to_herd(cow)
-
     def validate(self, connection):
         result = connection.information
 

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/herd/manager/__init__.py

@@ -43,4 +43,6 @@ class HerdManager:
         }
         names_to_create = self.herd_config.names - existing_names
 
-        return {self.herd_config.for_name(name) for name in names_to_create}
+        cows = {self.herd_config.for_name(name) for name in names_to_create}
+
+        return {cow for cow in cows if cow}

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/herd/manager/test_config.py

@@ -21,7 +21,7 @@ def test_config():
                 },
             },
         }
-    )
+    )  # type: ignore
     return config
 
 
@@ -44,7 +44,7 @@ def test_load_config(test_config):
     assert len(herd.cows) == 2
 
     moocow = herd.for_name("moocow")
-
+    assert moocow
     assert moocow.name == "moocow"
 
 

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/herd/manager/test_manager.py

@@ -21,7 +21,7 @@ def test_config():
                 },
             },
         }
-    )
+    )  # type: ignore
     return config
 
 

roboherd-0.1.4/roboherd/test_validators.py

@@ -0,0 +1,10 @@
+from dynaconf import Dynaconf
+
+from .validators import validators
+
+
+def test_validators():
+    settings = Dynaconf(validators=validators)
+
+    assert settings.base_url is None
+    assert settings.connection_string is None

{roboherd-0.1.2 → roboherd-0.1.4}/roboherd/util.py

@@ -4,7 +4,6 @@ import copy
 import importlib
 from importlib import import_module
 from urllib.parse import parse_qs, urlparse
-
 from almabtrieb import Almabtrieb
 
 from roboherd.cow import RoboCow

roboherd-0.1.4/roboherd/validators.py

@@ -0,0 +1,6 @@
+from dynaconf import Validator
+
+validators = [
+    Validator("base_url", default=None),
+    Validator("connection_string", default=None),
+]

{roboherd-0.1.2 → roboherd-0.1.4}/uv.lock

@@ -919,6 +919,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/99/b7/b9e70fde2c0f0c9af4cc5277782a89b66d35948ea3369ec9f598358c3ac5/multidict-6.1.0-py3-none-any.whl", hash = "sha256:48e171e52d1c4d33888e529b999e5900356b9ae588c2f09a52dcefb158b27506", size = 10051 },
 ]
 
+[[package]]
+name = "nodeenv"
+version = "1.9.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/43/16/fc88b08840de0e0a72a2f9d8c6bae36be573e475a6326ae854bcc549fc45/nodeenv-1.9.1.tar.gz", hash = "sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f", size = 47437 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/d2/1d/1b658dbd2b9fa9c4c9f32accbfc0205d532c8c6194dc0f2a4c0428e7128a/nodeenv-1.9.1-py2.py3-none-any.whl", hash = "sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9", size = 22314 },
+]
+
 [[package]]
 name = "packaging"
 version = "24.2"
@@ -1195,6 +1204,19 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/eb/f5/b9e2a42aa8f9e34d52d66de87941ecd236570c7ed2e87775ed23bbe4e224/pymdown_extensions-10.14.3-py3-none-any.whl", hash = "sha256:05e0bee73d64b9c71a4ae17c72abc2f700e8bc8403755a00580b49a4e9f189e9", size = 264467 },
 ]
 
+[[package]]
+name = "pyright"
+version = "1.1.394"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "nodeenv" },
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/b1/e4/79f4d8a342eed6790fdebdb500e95062f319ee3d7d75ae27304ff995ae8c/pyright-1.1.394.tar.gz", hash = "sha256:56f2a3ab88c5214a451eb71d8f2792b7700434f841ea219119ade7f42ca93608", size = 3809348 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/d6/4c/50c74e3d589517a9712a61a26143b587dba6285434a17aebf2ce6b82d2c3/pyright-1.1.394-py3-none-any.whl", hash = "sha256:5f74cce0a795a295fb768759bbeeec62561215dea657edcaab48a932b031ddbb", size = 5679540 },
+]
+
 [[package]]
 name = "pytest"
 version = "8.3.4"
@@ -1363,9 +1385,10 @@ wheels = [
 
 [[package]]
 name = "roboherd"
-version = "0.1.0"
+version = "0.1.4"
 source = { editable = "." }
 dependencies = [
+    { name = "aiohttp" },
     { name = "almabtrieb", extra = ["mqtt"] },
     { name = "apscheduler" },
     { name = "click" },
@@ -1387,6 +1410,7 @@ dev = [
     { name = "mkdocs-click" },
     { name = "mkdocs-material" },
     { name = "mkdocstrings-python" },
+    { name = "pyright" },
     { name = "pytest" },
     { name = "pytest-asyncio" },
     { name = "pytest-watcher" },
@@ -1395,6 +1419,7 @@ dev = [
 
 [package.metadata]
 requires-dist = [
+    { name = "aiohttp", specifier = ">=3.11.12" },
     { name = "almabtrieb", extras = ["mqtt"], specifier = ">=0.1.0a1" },
     { name = "apscheduler", specifier = ">=3.11.0" },
     { name = "bovine", marker = "extra == 'bovine'", specifier = ">=0.5.15" },
@@ -1412,6 +1437,7 @@ dev = [
     { name = "mkdocs-click", specifier = ">=0.8.1" },
     { name = "mkdocs-material", specifier = ">=9.5.50" },
     { name = "mkdocstrings-python", specifier = ">=1.13.0" },
+    { name = "pyright", specifier = ">=1.1.394" },
     { name = "pytest", specifier = ">=8.3.4" },
     { name = "pytest-asyncio", specifier = ">=0.25.2" },
     { name = "pytest-watcher", specifier = ">=0.4.3" },