roboherd 0.1.8__tar.gz → 0.1.9__tar.gz

{roboherd-0.1.8 → roboherd-0.1.9}/.woodpecker/create_release.yml

@@ -12,5 +12,4 @@ steps:
       CODEBERG_TOKEN: { from_secret: codeberg_token }
       CODEBERG_OWNER: bovine
       CODEBERG_REPO: roboherd
-      caddle_drive_connection_string:
-        { from_secret: caddle_drive_connection_string }
+      CONNECTION_STRING: { from_secret: caddle_drive_connection_string }

{roboherd-0.1.8 → roboherd-0.1.9}/.woodpecker/publish_docker.yml

@@ -9,7 +9,7 @@ depends_on: ["publish_pypi"]
 
 steps:
   publish_docker_latest:
-    image: woodpeckerci/plugin-docker-buildx
+    image: woodpeckerci/plugin-docker-buildx:6.0.2
     settings:
       platforms: linux/amd64,linux/arm64
       repo: helgekr/roboherd

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

@@ -1,5 +1,11 @@
 # Changes to roboherd
 
+## 0.1.9
+
+- Ensure roboherd terminates on connection close [roboherd#1](https://codeberg.org/bovine/roboherd/issues/1)
+- Make doc links clickable [roboherd#44](https://codeberg.org/bovine/roboherd/issues/44)
+- Document how to work with cattle_grid in `README.md`
+
 ## 0.1.8 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/11129))
 
 - Add ConfigOverrides model [roboherd#43](https://codeberg.org/bovine/roboherd/issues/43)

roboherd-0.1.9/PKG-INFO

@@ -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.9/README.md

@@ -0,0 +1,57 @@
+# 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.8 → roboherd-0.1.9}/docs/index.md

@@ -5,6 +5,15 @@ so by connecting to a server through the [Cattle Drive protocol](https://bovine.
 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,
+see [Configuration](#configuration).
+
+## Usage examples
+
+- Examples of basic usage can be found in [roboherd.examples](https://codeberg.org/bovine/roboherd/src/branch/main/roboherd/examples)
+- [release_helper](https://codeberg.org/helge/release_helper) automates the release of projects on codeberg and subsequent announcement on the Fediverse
+
+
 ## Tour of the functionality
 
 We will now tour how to write bots with Roboherd. We start with

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

@@ -40,6 +40,8 @@ markdown_extensions:
   - admonition
   - pymdownx.details
   - mkdocs-click
+  - toc:
+      permalink: true
 plugins:
   - search
   - mkdocstrings:

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

@@ -1,12 +1,12 @@
 [project]
 name = "roboherd"
-version = "0.1.8"
+version = "0.1.9"
 description = "A Fediverse bot framework"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
     "aiohttp>=3.11.12",
-    "almabtrieb[mqtt]>=0.1.0a1",
+    "almabtrieb[mqtt]>=0.2",
     "apscheduler>=3.11.0",
     "click>=8.1.8",
     "cron-descriptor>=1.4.5",

{roboherd-0.1.8 → roboherd-0.1.9}/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-0.1.8 → roboherd-0.1.9}/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-0.1.8 → roboherd-0.1.9}/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-0.1.8 → roboherd-0.1.9}/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-0.1.8 → roboherd-0.1.9}/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()