roboherd 0.1.13__tar.gz

roboherd-0.1.13/.gitignore

@@ -0,0 +1,5 @@
+herd.toml
+roboherd.toml
+*.whl
+tmp
+bovine_jsonld_cache.sqlite

roboherd-0.1.13/.woodpecker/create_release.yml

@@ -0,0 +1,15 @@
+when:
+  branch: [main]
+  event: [push]
+
+depends_on: ["test"]
+
+steps:
+  create_release:
+    image: helgekr/release_helper
+    pull: true
+    environment:
+      CODEBERG_TOKEN: { from_secret: codeberg_token }
+      CODEBERG_OWNER: bovine
+      CODEBERG_REPO: roboherd
+      CONNECTION_STRING: { from_secret: caddle_drive_connection_string }

roboherd-0.1.13/.woodpecker/publish_docker.yml

@@ -0,0 +1,33 @@
+when:
+  - event: tag
+    branch: main
+
+matrix:
+  PYTHON_VERSION: [3.13]
+
+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:
+      platforms: linux/amd64,linux/arm64
+      repo: helgekr/roboherd
+      username:
+        from_secret: docker_username
+      password:
+        from_secret: docker_password
+      dockerfile: resources/docker/Dockerfile
+      tags:
+        - latest
+        - ${CI_COMMIT_TAG}
+        - ${CI_COMMIT_TAG}-python${PYTHON_VERSION}
+      build_args:
+        tag: "${CI_COMMIT_TAG}"
+        python_tag: "${PYTHON_VERSION}"
+    when:
+      - matrix: { PYTHON_VERSION: 3.13 }

roboherd-0.1.13/.woodpecker/publish_pypi.yml

@@ -0,0 +1,13 @@
+when:
+  - event: tag
+    branch: main
+steps:
+  publish_pypi:
+    image: ghcr.io/astral-sh/uv:python3.11-alpine
+    commands:
+      - uv sync --frozen
+      - uv build
+      - uv publish --token  $PYPI_API_KEY
+    environment:
+      PYPI_API_KEY:
+        from_secret: pypi_api_key

roboherd-0.1.13/.woodpecker/test.yml

@@ -0,0 +1,38 @@
+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 ${extras}
+  test_format:
+    image: ghcr.io/astral-sh/uv:python3.11-alpine
+    commands:
+      - uv run ruff format --check .
+      - uv run ruff check .
+    when:
+      - matrix: { extras: "--all-extras" }
+  test_pytest:
+    image: ghcr.io/astral-sh/uv:python3.11-alpine
+    commands:
+      - uv run pytest roboherd
+  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:
+      - cp CHANGES.md docs/CHANGES.md
+      - uv sync --group docs
+      - uv run mkdocs build
+    when:
+      - matrix: { extras: "--all-extras" }

roboherd-0.1.13/.woodpecker/website.yml

@@ -0,0 +1,17 @@
+when:
+  branch: main
+  event: push
+
+steps:
+  build:
+    image: ghcr.io/astral-sh/uv:python3.11-alpine
+    commands:
+      - uv sync --all-extras --group docs
+      - cp CHANGES.md docs/CHANGES.md
+      - uv run mkdocs build
+  deploy:
+    image: codeberg.org/xfix/plugin-codeberg-pages-deploy:1
+    settings:
+      folder: site
+      ssh_key:
+        from_secret: deploy_ssh_key

roboherd-0.1.13/CHANGES.md

@@ -0,0 +1,72 @@
+# Changes to roboherd
+
+## 0.1.13
+
+* add basic setup for bdd
+* use optional dependencies for `roboherd[amqp]` and `roboherd[mqtt]`
+
+## 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)
+- Repair passing build_args to docker buildx [roboherd#51](https://codeberg.org/bovine/roboherd/issues/51)
+
+## 0.1.10
+
+- Add check command [roboherd#48](https://codeberg.org/bovine/roboherd/issues/48)
+
+## 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)
+- 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)
+- Enable direct posting of markdown [roboherd#35](https://codeberg.org/bovine/roboherd/issues/35)
+
+## 0.1.5 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/10581))
+
+- Allow overriding the base_url [roboherd#12](https://codeberg.org/bovine/roboherd/issues/12)
+- Separate out the internal state of a RoboCow
+- If no preferredUsername is set and handle is updated, send Update Service [roboherd#33](https://codeberg.org/bovine/roboherd/issues/33)
+- Add an icon property [roboherd#10](https://codeberg.org/bovine/roboherd/issues/10)
+- Added a logo [roboherd#32](https://codeberg.org/bovine/roboherd/issues/32)
+- Add PublishActivity annotation [roboherd#30](https://codeberg.org/bovine/roboherd/issues/30)
+
+## 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)
+- Add minimal password length (6 characters) for roboherd register
+- Finish documentation [roboherd#6](https://codeberg.org/bovine/roboherd/issues/6)
+- Add a roboherd register command
+- Repair bovine annotations [roboherd#11](https://codeberg.org/bovine/roboherd/issues/11)
+- Enable setting the type of the actor [roboherd#9](https://codeberg.org/bovine/roboherd/issues/9)
+- Enable setting PropertyValues for the cow actor [roboherd#4](https://codeberg.org/bovine/roboherd/issues/4)

roboherd-0.1.13/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: roboherd
+Version: 0.1.13
+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: almabtrieb>=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>=3.0.0
+Requires-Dist: pydantic==2.12.3
+Requires-Dist: tomli-w>=1.1.0
+Provides-Extra: amqp
+Requires-Dist: almabtrieb[amqp]>=0.2.8; extra == 'amqp'
+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'
+Provides-Extra: mqtt
+Requires-Dist: almabtrieb[mqtt]>=0.2.8; extra == 'mqtt'
+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).
+
+## BDD Tests
+
+Start the pasture currently from containers. Run a runner container via
+
+```bash
+docker run --rm -it -e UV_PROJECT_ENVIRONMENT=/tmp/venv\
+    -v .:/app --workdir /app\
+    --network fediverse-pasture\
+    ghcr.io/astral-sh/uv:alpine /bin/sh
+```

roboherd-0.1.13/README.md

@@ -0,0 +1,68 @@
+# 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).
+
+## BDD Tests
+
+Start the pasture currently from containers. Run a runner container via
+
+```bash
+docker run --rm -it -e UV_PROJECT_ENVIRONMENT=/tmp/venv\
+    -v .:/app --workdir /app\
+    --network fediverse-pasture\
+    ghcr.io/astral-sh/uv:alpine /bin/sh
+```

roboherd-0.1.13/cattle_grid.toml

@@ -0,0 +1,6 @@
+version = 2
+amqp_url = "amqp://guest:guest@cattle_grid_mq/"
+# amqp_url = "amqp://guest:guest@rabbitmq/"
+db_url = "postgresql+asyncpg://postgres:pass@cattle_grid_db/"
+
+"frontend.base_urls" = ["http://cattle_grid"]

roboherd-0.1.13/docs/annotations.md

@@ -0,0 +1 @@
+:::roboherd.annotations

roboherd-0.1.13/docs/cli.md

@@ -0,0 +1,18 @@
+# Command Line Interface
+
+The simplest usage of the command line interface is just
+to run
+
+```bash
+roboherd run
+```
+
+!!! info
+    The watch and register commands require you to install
+    `roboherd[dev]`.
+
+::: mkdocs-click
+    :module: roboherd.__main__
+    :command: main
+    :prog_name: roboherd
+    :depth: 2

roboherd-0.1.13/docs/cow.md

@@ -0,0 +1 @@
+:::roboherd.cow

roboherd-0.1.13/docs/herd.md

@@ -0,0 +1 @@
+:::roboherd.herd