roboherd 0.1.11__tar.gz → 0.1.12__tar.gz

{roboherd-0.1.11 → roboherd-0.1.12}/.woodpecker/publish_docker.yml

@@ -8,6 +8,10 @@ matrix:
 depends_on: ["publish_pypi"]
 
 steps:
+  sleep:
+    image: ghcr.io/astral-sh/uv:python3.11-alpine
+    commands:
+      - sleep 120
   publish_docker_latest:
     image: woodpeckerci/plugin-docker-buildx:6.0.2
     settings:

{roboherd-0.1.11 → roboherd-0.1.12}/.woodpecker/test.yml

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

{roboherd-0.1.11 → roboherd-0.1.12}/.woodpecker/website.yml

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

{roboherd-0.1.11 → roboherd-0.1.12}/CHANGES.md

@@ -1,5 +1,11 @@
 # Changes to roboherd
 
+## 0.1.12
+
+- Add ability to set description by markdown
+- Add py.typed [roboherd#54](https://codeberg.org/bovine/roboherd/issues/54)
+- Fix typo [roboherd#55](https://codeberg.org/bovine/roboherd/issues/55)
+
 ## 0.1.11
 
 - Add `--version` flag [roboherd#50](https://codeberg.org/bovine/roboherd/issues/50)

{roboherd-0.1.11 → roboherd-0.1.12}/PKG-INFO

@@ -1,22 +1,23 @@
 Metadata-Version: 2.4
 Name: roboherd
-Version: 0.1.11
+Version: 0.1.12
 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: fast-depends>=3.0.0
 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'
+Provides-Extra: dev
+Requires-Dist: aiohttp>=3.11.12; extra == 'dev'
+Requires-Dist: watchfiles>=1.0.4; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Roboherd

{roboherd-0.1.11 → roboherd-0.1.12}/docs/cli.md

@@ -7,6 +7,10 @@ to run
 roboherd run
 ```
 
+!!! info
+    The watch and register commands require you to install
+    `roboherd[dev]`.
+
 ::: mkdocs-click
     :module: roboherd.__main__
     :command: main

{roboherd-0.1.11 → roboherd-0.1.12}/docs/index.md

@@ -1,11 +1,12 @@
 # Roboherd
 
 Roboherd is a tool to build automated Fediverse actors. It does
-so by connecting to a server through the [Cattle Drive protocol](https://bovine.codeberg.page/cattle_grid/cattle_drive/) protocol. Once you have
+so by connecting to a server through the [Cattle Drive protocol](https://bovine.codeberg.page/cattle_grid/cattle_drive/) 
+protocol. Once you have
 configured the connection, all other tasks can be done using
 python code and a toml configuration file.
 
-The serer roboherd connects to is specified through a connection string,
+The server roboherd connects to is specified through a connection string,
 see [Configuration](#configuration).
 
 ## Usage examples

{roboherd-0.1.11 → roboherd-0.1.12}/pyproject.toml

@@ -4,15 +4,13 @@ description = "A Fediverse bot framework"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
-    "aiohttp>=3.11.12",
     "almabtrieb[mqtt]>=0.2",
     "apscheduler>=3.11.0",
     "click>=8.1.8",
     "cron-descriptor>=1.4.5",
     "dynaconf>=3.2.6",
-    "fast-depends>=2.4.12",
+    "fast-depends>=3.0.0",
     "tomli-w>=1.1.0",
-    "watchfiles>=1.0.4",
 ]
 
 dynamic = ["version"]
@@ -36,24 +34,27 @@ roboherd = "roboherd.__main__:main"
 
 [project.optional-dependencies]
 bovine = ["bovine>=0.5.15", "markdown>=3.7"]
+dev = ["aiohttp>=3.11.12", "watchfiles>=1.0.4"]
 
-[tool.uv]
-dev-dependencies = [
+[dependency-groups]
+dev = [
     "pytest>=8.3.4",
     "pytest-asyncio>=0.25.2",
     "pytest-watcher>=0.4.3",
-    "mkdocs-material>=9.5.50",
+    "ruff>=0.9.6",
+    "pyright>=1.1.394",
+]
+docs = [
+    "mkdocs-material==9.6.20",
     "mkdocstrings-python>=1.13.0",
     "griffe-fieldz>=0.2.1",
     "mkdocs-click>=0.8.1",
-    "ruff>=0.9.6",
-    "pyright>=1.1.394",
 ]
 
 [tool.pytest.ini_options]
 addopts = "--doctest-modules"
 asyncio_mode = "auto"
-log_cli = 1
-log_cli_level = "info"
+log_cli = true
+log_cli_level = "INFO"
 doctest_optionflags = "NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS"
 testpaths = ["roboherd/**/*.py"]

{roboherd-0.1.11 → roboherd-0.1.12}/roboherd/__main__.py

@@ -4,7 +4,6 @@ import os
 
 import click
 import dynaconf
-import watchfiles
 
 from roboherd.herd import RoboHerd
 from roboherd.herd.manager import HerdManager
@@ -113,6 +112,7 @@ def watch(ctx):
     """Watches the file the module is in for changes and then restarts roboherd.
 
     Note: Options for roboherd are currently ignored (FIXME)."""
+    import watchfiles
 
     watchfiles.run_process("roboherd", target="roboherd run")
 

{roboherd-0.1.11 → roboherd-0.1.12}/roboherd/annotations/common.py

@@ -1,5 +1,5 @@
 from fast_depends import Depends
-from typing import Annotated, Callable, Awaitable
+from typing import Annotated, Any, Callable, Awaitable
 
 from almabtrieb import Almabtrieb
 
@@ -7,17 +7,17 @@ from almabtrieb import Almabtrieb
 from roboherd.cow import RoboCow
 
 
-def get_profile(cow: RoboCow) -> dict:
+def get_profile(cow: RoboCow) -> dict[str, Any]:
     if cow.internals.profile is None:
         raise ValueError("Cow has no profile")
     return cow.internals.profile
 
 
-Profile = Annotated[dict, Depends(get_profile)]
+Profile = Annotated[dict[str, Any], Depends(get_profile)]
 """The profile of the cow"""
 
 
-Publisher = Callable[[dict], Awaitable[None]]
+Publisher = Callable[[dict[str, Any]], Awaitable[None]]
 """Type returned by the publishing functions"""
 
 

{roboherd-0.1.11 → roboherd-0.1.12}/roboherd/cow/__init__.py

@@ -1,6 +1,6 @@
 import logging
 
-from typing import Callable, List
+from typing import Any, Callable, List
 
 from dataclasses import dataclass, field
 from fast_depends import inject
@@ -28,7 +28,7 @@ class CronEntry:
 class RoboCowInternals:
     """Internal data for the cow"""
 
-    profile: dict | None = field(
+    profile: dict[str, Any] | None = field(
         default=None,
         metadata=dict(
             description="""The profile of the cow, aka as the actor object in ActivityPub"""
@@ -90,11 +90,33 @@ class RoboCow:
 
     @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"))`.
+        """Creates a new cow, by creating a new [Information][roboherd.cow.types.Information].
+
+        ```python
+        >>> RoboCow.create(name="my cow")
+        RoboCow(information=Information(type='Service', handle=None, name='my cow', ...
+
+        ```
+
+        The parameter `description_md` is transformed from markdown to html and then
+        assigned to `description`.
+
+        ```python
+        >> cow = RoboCow.create(description_md="__bold__")
+        >> cow.information.description
+        '<p><strong>bold</strong></p>'
+
+        ```
         """
-        return RoboCow(information=Information(**kwargs))
+
+        if "description_md" in kwargs:
+            import markdown
+
+            kwargs["description"] = markdown.markdown(kwargs["description_md"])
+            del kwargs["description_md"]
+
+        information = Information.model_validate(kwargs)
+        return RoboCow(information=information)
 
     def action(self, action: str = "*", activity_type: str = "*"):
         """Adds a handler for an event. Use "*" as a wildcard.

{roboherd-0.1.11 → roboherd-0.1.12}/roboherd/cow/test_init.py

@@ -1,3 +1,4 @@
+import pytest
 from unittest.mock import AsyncMock
 
 from . import RoboCow
@@ -39,3 +40,13 @@ async def test_skip_startup():
     await cow.run_startup(connection=connection)
 
     connection.trigger.assert_not_awaited()
+
+
+@pytest.mark.skipif(
+    not pytest.importorskip("markdown"), reason="markdown not installed"
+)
+def test_create():
+    cow = RoboCow.create(handle="testcow", description_md="__bold__")
+
+    assert cow.information.handle == "testcow"
+    assert cow.information.description == "<p><strong>bold</strong></p>"

roboherd-0.1.12/roboherd/examples/json_echo.py

@@ -0,0 +1,51 @@
+import json
+
+from roboherd import RoboCow, RawData, PublishObject, ObjectFactory
+
+from .meta import meta_information
+
+
+def reply_content(raw: dict) -> str:
+    """Formats and escapes the JSON data:
+
+    ```pycon
+    >>> reply_content({"html": "<b>bold</b>"})
+    '<pre><code>{\\n  "html": "&lt;b&gt;bold&lt;/b&gt;"\\n}</code></re>'
+
+    ```
+    """
+    json_formatted = (
+        json.dumps(raw, indent=2)
+        .replace("&", "&amp;")
+        .replace("<", "&lt;")
+        .replace(">", "&gt;")
+    )
+    return f"<pre><code>{json_formatted}</code></re>"
+
+
+try:
+    bot = RoboCow.create(
+        handle="jsonecho",
+        name="JSON Echo {}",
+        description_md="""I'm a silly bot that replies to
+    you with the JSON as received through a HTTP
+    post request by [cattle_grid](https://bovine.codeberg.page/cattle_grid/).""",
+        meta_information=meta_information,
+    )
+
+    @bot.incoming_create
+    async def create(
+        raw: RawData, publish_object: PublishObject, object_factory: ObjectFactory
+    ):
+        note = (
+            object_factory.reply(  # type: ignore
+                raw.get("object"),
+                content=reply_content(raw),
+            )
+            .as_public()
+            .build()
+        )
+
+        await publish_object(note)
+except ImportError:
+    ...

{roboherd-0.1.11 → roboherd-0.1.12}/roboherd/register.py

@@ -1,4 +1,3 @@
-import aiohttp
 import tomli_w
 
 
@@ -24,6 +23,8 @@ def create_config(
 
 
 async def register(config_file: str, name: str, password: str, fediverse: str):
+    import aiohttp
+
     async with aiohttp.ClientSession() as session:
         result = await session.post(
             "https://dev.bovine.social/register",

roboherd-0.1.12/roboherd/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.12"