roboherd 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of roboherd might be problematic. Click here for more details.

roboherd/__main__.py CHANGED
@@ -13,6 +13,7 @@ from roboherd.register import register as run_register
13
13
  from roboherd.validators import validators
14
14
 
15
15
  logging.basicConfig(level=logging.INFO)
16
+ logging.captureWarnings(True)
16
17
 
17
18
 
18
19
  @click.group()
@@ -5,6 +5,7 @@ from .meta import meta_information
5
5
  bot = RoboCow.create(
6
6
  handle="rooster",
7
7
  name="The crowing rooster 🐓",
8
+ description="I'm a rooster that crows at a set frequency.",
8
9
  meta_information=meta_information,
9
10
  )
10
11
 
roboherd/herd/__init__.py CHANGED
@@ -63,6 +63,8 @@ class RoboHerd:
63
63
  scheduler = HerdScheduler(self.cron_entries(), connection)
64
64
  scheduler.create_task(tg)
65
65
 
66
+ connection.add_on_disconnect(scheduler.stop)
67
+
66
68
  def validate(self, connection):
67
69
  result = connection.information
68
70
 
@@ -28,12 +28,15 @@ class HerdProcessor:
28
28
  for cow in self.incoming_handlers:
29
29
  actor_id_to_cow_map[cow.internals.actor_id] = cow
30
30
 
31
+ logger.info("Incoming processing started for %s cows", len(actor_id_to_cow_map))
32
+
31
33
  async for msg in connection.incoming():
32
34
  actor_id = msg["actor"]
33
35
 
34
36
  cow = actor_id_to_cow_map.get(actor_id)
35
- logger.info(cow)
36
37
  if cow:
37
38
  await cow.internals.handlers.handle(
38
39
  msg, "incoming", connection, actor_id, cow=cow
39
40
  )
41
+
42
+ logger.warning("Process incoming ended")
@@ -19,22 +19,30 @@ logger = logging.getLogger(__name__)
19
19
  class HerdScheduler:
20
20
  entries: List[Tuple[RoboCow, CronEntry]]
21
21
  connection: Almabtrieb
22
+ scheduler: AsyncIOScheduler | None = None
23
+ task: asyncio.Task | None = None
22
24
 
23
25
  def create_task(self, task_group: asyncio.TaskGroup):
24
26
  if len(self.entries) == 0:
25
27
  logger.info("No tasks to schedule")
26
28
  return
27
- task_group.create_task(self.run())
29
+ if self.task:
30
+ raise Exception("Task already running")
31
+
32
+ self.task = task_group.create_task(self.run())
28
33
 
29
34
  async def run(self):
30
35
  if len(self.entries) == 0:
31
36
  return
32
37
 
33
- scheduler = AsyncIOScheduler()
38
+ if self.scheduler:
39
+ raise Exception("Scheduler already exists")
40
+
41
+ self.scheduler = AsyncIOScheduler()
34
42
 
35
43
  for cow, entry in self.entries:
36
44
  trigger = CronTrigger.from_crontab(entry.crontab)
37
- scheduler.add_job(
45
+ self.scheduler.add_job(
38
46
  inject(entry.func),
39
47
  trigger=trigger,
40
48
  kwargs={
@@ -44,7 +52,14 @@ class HerdScheduler:
44
52
  },
45
53
  )
46
54
 
47
- scheduler.start()
55
+ self.scheduler.start()
48
56
 
49
57
  while True:
50
58
  await asyncio.sleep(60 * 60)
59
+
60
+ async def stop(self):
61
+ logger.warning("Stopping scheduler")
62
+ if self.scheduler:
63
+ self.scheduler.shutdown()
64
+ if self.task:
65
+ self.task.cancel()
@@ -0,0 +1,78 @@
1
+ Metadata-Version: 2.4
2
+ Name: roboherd
3
+ Version: 0.1.9
4
+ Summary: A Fediverse bot framework
5
+ Project-URL: Documentation, https://bovine.codeberg.page/roboherd/
6
+ Project-URL: Repository, https://codeberg.org/bovine/roboherd
7
+ Requires-Python: >=3.11
8
+ Requires-Dist: aiohttp>=3.11.12
9
+ Requires-Dist: almabtrieb[mqtt]>=0.2
10
+ Requires-Dist: apscheduler>=3.11.0
11
+ Requires-Dist: click>=8.1.8
12
+ Requires-Dist: cron-descriptor>=1.4.5
13
+ Requires-Dist: dynaconf>=3.2.6
14
+ Requires-Dist: fast-depends>=2.4.12
15
+ Requires-Dist: tomli-w>=1.1.0
16
+ Requires-Dist: watchfiles>=1.0.4
17
+ Provides-Extra: bovine
18
+ Requires-Dist: bovine>=0.5.15; extra == 'bovine'
19
+ Requires-Dist: markdown>=3.7; extra == 'bovine'
20
+ Description-Content-Type: text/markdown
21
+
22
+ # Roboherd
23
+
24
+ Roboherd is a framework for building Fediverse bots
25
+ using the [Cattle Drive Protocol](https://bovine.codeberg.page/cattle_grid/cattle_drive/).
26
+
27
+ For more information, see the [documentation](https://bovine.codeberg.page/roboherd/) or the [repository](https://codeberg.org/bovine/roboherd/).
28
+
29
+ ## Developping with cattle_grid
30
+
31
+ In your catle_grid `config` directory add a roboherd user, e.g.
32
+ a file `testing.toml` with content
33
+
34
+ ```toml
35
+ [testing]
36
+ enable = true
37
+
38
+ [[testing.accounts]]
39
+ name = "herd"
40
+ password = "pass"
41
+ permissions = ["admin"]
42
+ ```
43
+
44
+ Configure roboherd via `roboherd.toml`, e.g.
45
+
46
+ ```toml
47
+ base_url = "http://abel"
48
+ connection_string = "ws://herd:pass@localhost:3000/ws/"
49
+
50
+ [cow.rooster]
51
+ bot = "roboherd.examples.rooster:bot"
52
+ ```
53
+
54
+ This will trigger a periodic message to cattle_grid.
55
+
56
+ ### nginx for cattle_grid
57
+
58
+ The nginx in the `cattle_grid` configuration should forward the path `/ws/` to
59
+ rabbitmq (supporting mqtt over websockets)
60
+
61
+ ```nginx
62
+ server {
63
+ listen 80;
64
+
65
+ location /ws/ {
66
+ proxy_pass http://rabbitmq:15675;
67
+ proxy_http_version 1.1;
68
+ proxy_set_header Upgrade $http_upgrade;
69
+ proxy_set_header Connection $connection_upgrade;
70
+ proxy_read_timeout 86400; # neccessary to avoid websocket timeout disconnect
71
+ proxy_send_timeout 86400; # neccessary to avoid websocket timeout disconnect
72
+ proxy_redirect off;
73
+ proxy_buffering off;
74
+ }
75
+ }
76
+ ```
77
+
78
+ similarly `nginx` should forward port 80 to 3000 (in the docker compose file).
@@ -1,5 +1,5 @@
1
1
  roboherd/__init__.py,sha256=E89YtYyL77iJDJJkHS4Pn0JdTbmkmQS7Cp_XPqpRgx8,533
2
- roboherd/__main__.py,sha256=cY4f-39QCDhStJ4gDuuSz46RDFE_AKnu08sTCpQEEV4,2933
2
+ roboherd/__main__.py,sha256=DMsxzSdO_tN0RazYcJicF1eZZzWT7NAYg3jXi7kEuU8,2963
3
3
  roboherd/register.py,sha256=Gqa5aT2supVJMj7z21btMYRma3_WW0oK5gjZftr048s,976
4
4
  roboherd/test_validators.py,sha256=UiFgJkutmXBLjGpdLP2IBYCEf75quwnRHX7Z51G8Xqo,222
5
5
  roboherd/util.py,sha256=nrFRtyfvMQ8oXoGDYxmCAXcIN14dWBAPGv0cI_B_TP0,1710
@@ -23,12 +23,12 @@ roboherd/examples/json_echo.py,sha256=TB7sdshsTj7KKOxIc1DzkGeacA9JmIOhNOHwGzyRrV
23
23
  roboherd/examples/meta.py,sha256=tFhHe-DJn2J13Mm22f-gFm5I8_3uQwLU4mAkrK2xzEM,170
24
24
  roboherd/examples/moocow.py,sha256=2bZ8oZOpysuf7l3DP3zM4YiaALQHFbWpbP3h_Xlok6E,974
25
25
  roboherd/examples/number.py,sha256=c4zALxrKR5POuAUTmzAF4wHVgXMPfrP736N7dgn4xzo,1845
26
- roboherd/examples/rooster.py,sha256=E-bqm8AKy_EOzptaH6xrlc5eDE8o9SBhfdNqHpEhUb4,437
26
+ roboherd/examples/rooster.py,sha256=ItPBpxhz72agkzFf13nv6csYVUJCZRabtUaGyKwUKRg,501
27
27
  roboherd/examples/scarecrow.py,sha256=jUnBaDJ2w9LQNIJAAfA53oJyRvKPJoKHtvHbeW-Pex0,626
28
- roboherd/herd/__init__.py,sha256=6jWgYnuJOpXtYS03mdjEgWd0zXv5kj9w9d7K6UsCPbc,3068
28
+ roboherd/herd/__init__.py,sha256=AtmpzoIbJwX82cx-9GdYMYQ5guj2vWb1dVYNGc1PReo,3126
29
29
  roboherd/herd/builder.py,sha256=MSVPRF0Jsxure9kdyCoYJHQ7nYilGAD0_uQaGQ-rQyE,619
30
- roboherd/herd/processor.py,sha256=ncXsYfuTRTT_0-K453COF_oAiGBJN0u5eP8NoeZmWik,1042
31
- roboherd/herd/scheduler.py,sha256=pbWxOo9pnjAoAJhbvaczmSghkp6Y8Zp2HgXZ5zoOnDA,1276
30
+ roboherd/herd/processor.py,sha256=4wZUp4xND9ZhxLIedUN7Yu3jxKWuuFqJent7wRiaAE0,1153
31
+ roboherd/herd/scheduler.py,sha256=4zAPJkWs1ZGHlwTweHdhYb5xrHnpiSTpTEQ64drA-oE,1735
32
32
  roboherd/herd/test_herd.py,sha256=sQkzGCWdFveLklhaOJUybtl7odO-QOSDdd-_gan1py8,845
33
33
  roboherd/herd/test_scheduler.py,sha256=wLisqRMSl734P_rjbqMNH5WTQKepwihgr7ZC32nEj80,424
34
34
  roboherd/herd/types.py,sha256=_EidQbglm0jpsKX1EsL6U2qm_J5wCPhwUi6Avac22Ow,210
@@ -38,7 +38,7 @@ roboherd/herd/manager/load.py,sha256=BoeBID2UGP--sIKwITABQkQv2lMc9Y8pyp7_nleu2bw
38
38
  roboherd/herd/manager/test_config.py,sha256=I2EP7nEUdBVO8Wqot7SRhzp5UZFr5oGIuFS7cNB2iFk,1745
39
39
  roboherd/herd/manager/test_load.py,sha256=zyu5LIChMfTnxu_tYK63-bSOHYn1K1zUlbDY5DkE3GY,514
40
40
  roboherd/herd/manager/test_manager.py,sha256=9pSMaH7zmN-zagYCIBpQcV3Q0sBT7XZSCvsmLVC0rOI,1047
41
- roboherd-0.1.8.dist-info/METADATA,sha256=SoBEuuNWN1AYoDfom7330kaSYHcKYTzfIARF0FqE4NM,1007
42
- roboherd-0.1.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
43
- roboherd-0.1.8.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
44
- roboherd-0.1.8.dist-info/RECORD,,
41
+ roboherd-0.1.9.dist-info/METADATA,sha256=OPELZHKFq-g1XS1XqUzyvhE6ygMyTutw4YshGFpW3_8,2205
42
+ roboherd-0.1.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
43
+ roboherd-0.1.9.dist-info/entry_points.txt,sha256=WebdVUmh8Ot-FupKJY6Du8LuFbmezt9yoy2UICqV3bE,52
44
+ roboherd-0.1.9.dist-info/RECORD,,
@@ -1,27 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: roboherd
3
- Version: 0.1.8
4
- Summary: A Fediverse bot framework
5
- Project-URL: Documentation, https://bovine.codeberg.page/roboherd/
6
- Project-URL: Repository, https://codeberg.org/bovine/roboherd
7
- Requires-Python: >=3.11
8
- Requires-Dist: aiohttp>=3.11.12
9
- Requires-Dist: almabtrieb[mqtt]>=0.1.0a1
10
- Requires-Dist: apscheduler>=3.11.0
11
- Requires-Dist: click>=8.1.8
12
- Requires-Dist: cron-descriptor>=1.4.5
13
- Requires-Dist: dynaconf>=3.2.6
14
- Requires-Dist: fast-depends>=2.4.12
15
- Requires-Dist: tomli-w>=1.1.0
16
- Requires-Dist: watchfiles>=1.0.4
17
- Provides-Extra: bovine
18
- Requires-Dist: bovine>=0.5.15; extra == 'bovine'
19
- Requires-Dist: markdown>=3.7; extra == 'bovine'
20
- Description-Content-Type: text/markdown
21
-
22
- # Roboherd
23
-
24
- Roboherd is a framework for building Fediverse bots
25
- using the [Cattle Drive Protocol](https://bovine.codeberg.page/cattle_grid/cattle_drive/).
26
-
27
- For more information, see the [documentation](https://bovine.codeberg.page/roboherd/) or the [repository](https://codeberg.org/bovine/roboherd/).