roboherd 0.1.10__py3-none-any.whl → 0.1.12__py3-none-any.whl

roboherd/__main__.py

@@ -4,19 +4,19 @@ import os
 
 import click
 import dynaconf
-import watchfiles
 
 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
+from roboherd.version import __version__
 
 logging.basicConfig(level=logging.INFO)
 logging.captureWarnings(True)
 
 
-@click.group()
+@click.group(invoke_without_command=True)
 @click.option(
     "--connection_string",
     default=None,
@@ -28,9 +28,22 @@ logging.captureWarnings(True)
     help="Base url to create cows with",
 )
 @click.option("--config_file", default="roboherd.toml", help="Configuration file")
+@click.option(
+    "--version", is_flag=True, default=False, help="display version then exit"
+)
 @click.pass_context
-def main(ctx: click.Context, connection_string: str, base_url: str, config_file: str):
+def main(
+    ctx: click.Context,
+    connection_string: str,
+    base_url: str,
+    config_file: str,
+    version: bool,
+):
     """Configuration is usually loaded from the config_file. These options can be overwritten by passing as a command line argument."""
+    if version:
+        print(f"roboherd version: {__version__}")
+        exit(0)
+
     settings = dynaconf.Dynaconf(
         settings_files=[config_file],
         envvar_prefix="ROBOHERD",
@@ -51,6 +64,8 @@ def main(ctx: click.Context, connection_string: str, base_url: str, config_file:
     else:
         ctx.obj["base_url"] = settings.base_url  # type: ignore
 
+    print("Please specify a command")
+
 
 @main.command()
 @click.option("--fail", is_flag=True, default=False, help="Fail if actors do not exist")
@@ -97,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/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/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/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/examples/json_echo.py

@@ -4,18 +4,6 @@ from roboherd import RoboCow, RawData, PublishObject, ObjectFactory
 
 from .meta import meta_information
 
-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,
-)
-
 
 def reply_content(raw: dict) -> str:
     """Formats and escapes the JSON data:
@@ -35,17 +23,29 @@ def reply_content(raw: dict) -> str:
     return f"<pre><code>{json_formatted}</code></re>"
 
 
-@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()
+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,
     )
 
-    await publish_object(note)
+    @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/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/version.py

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

{roboherd-0.1.10.dist-info → roboherd-0.1.12.dist-info}/METADATA

@@ -1,22 +1,23 @@
 Metadata-Version: 2.4
 Name: roboherd
-Version: 0.1.10
+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.10.dist-info → roboherd-0.1.12.dist-info}/RECORD

@@ -1,25 +1,27 @@
 roboherd/__init__.py,sha256=E89YtYyL77iJDJJkHS4Pn0JdTbmkmQS7Cp_XPqpRgx8,533
-roboherd/__main__.py,sha256=DxxPrubMXNp_rqE-1S-S7pCn065CfQo2uHmxP1FWZU4,3655
-roboherd/register.py,sha256=jnnHv-epeyXHcmmulxJoHqT7uWmb_efFnCbdxojKOBM,1044
+roboherd/__main__.py,sha256=q_Ucf-S_TlnVMYzZA58p1I8kQFwoCvVjMSe3ks1ihUs,3983
+roboherd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+roboherd/register.py,sha256=a3RKeDfyU-Lz7AWqJvQvY34Y8osmJPeHJDbgiTE5hYw,1049
 roboherd/test_validators.py,sha256=UiFgJkutmXBLjGpdLP2IBYCEf75quwnRHX7Z51G8Xqo,222
 roboherd/util.py,sha256=gG8Scht1xRfauUOdL7GrLf9e3UO-j88X2wEdc1Ymm3o,1748
 roboherd/validators.py,sha256=2mc43ZGwFazp4f3B9J4RxZCU4Y_ErSNotib8MnYVtmY,140
+roboherd/version.py,sha256=LcIlFjHZFfiF9Rd4UHoakmombOFkxIYk00I181frGBM,23
 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=wSfYordSLmn3azxWkZs36h3ipbS6NdPh9kAWyyg0NIU,6223
+roboherd/annotations/common.py,sha256=HOysWNm4FRnFJ8Byn6UVyJHp60gh2Hsy2_5qCifpXF8,1386
+roboherd/cow/__init__.py,sha256=NqkNhEyMxC-j5AVJyh2R5VJTzwNe4xId-Ot4JCr302U,6862
 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=GrOFyEKbvkddrUQM7B0RFelNLc_rmdlxU_8C-DjoUh8,999
+roboherd/cow/test_init.py,sha256=GT4OQRxc8fyQhHWaNNu0Qlh7A6J3hHzZw3G7xDZCwis,1321
 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=P2_tVh5Y6Cm7A0FQzX7lRaBlXZZqBsia89Jnoa-s5ek,217
-roboherd/examples/json_echo.py,sha256=TB7sdshsTj7KKOxIc1DzkGeacA9JmIOhNOHwGzyRrVY,1208
+roboherd/examples/json_echo.py,sha256=K4uWpOVnDAPoxTwvFiLGobTG0oeJjYa18kptRgaT6EU,1302
 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
@@ -38,7 +40,7 @@ roboherd/herd/manager/load.py,sha256=BoeBID2UGP--sIKwITABQkQv2lMc9Y8pyp7_nleu2bw
 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.10.dist-info/METADATA,sha256=rYVd_FKmmzULegTCdV9Xvp8W4Vn-DcKn_xokqfoUPPA,2206
-roboherd-0.1.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-roboherd-0.1.10.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
-roboherd-0.1.10.dist-info/RECORD,,
+roboherd-0.1.12.dist-info/METADATA,sha256=JitOq-gB0wsm3mokPow67oBsCqd2cazmEra4n5GRMJ8,2257
+roboherd-0.1.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+roboherd-0.1.12.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
+roboherd-0.1.12.dist-info/RECORD,,