socialrobot 0.2.0__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.
@@ -0,0 +1,67 @@
1
+ """Social Robot Platform SDK — a RUNTIME client, not an authoring tool.
2
+
3
+ The supported public API is the runtime half: connect a non-Android robot
4
+ body (or any program) to a live platform session, and drive/observe it.
5
+
6
+ from socialrobot import SocialRobotClient, RobotSession
7
+
8
+ `RobotSession` is how a NAO, a Raspberry Pi rig, or any Python-driven body
9
+ participates as a robot — meme is the brain, your process is the body (see
10
+ `examples/nao_meme_bridge.py`). `SocialRobotClient` is the authenticated REST
11
+ client underneath it, plus the asset/session endpoints those bodies need.
12
+
13
+ INTERNAL, NOT PUBLIC API — the Builder DSL (`Character`, `Script`, `Say`,
14
+ `Agent`, `Screen`, `Identify`, hooks, …). Authoring a character is the
15
+ WEB EDITOR's job: a Builder script still has to `deploy()` its result up to
16
+ the backend, so it buys nothing a designer can't do on the canvas, and the
17
+ canvas is the surface that actually gets maintained. The module stays in the
18
+ repo because the platform's own seed scripts and ~15 e2e drivers provision
19
+ their fixture characters with it (`server/scripts/seed_*.py`,
20
+ `server/scripts/e2e_*.py`) — it is test/provisioning infrastructure now.
21
+
22
+ Those names are still importable so that in-repo tooling keeps working, but
23
+ they are deliberately absent from `__all__`, excluded from the documented
24
+ surface, and carry no compatibility promise for external callers. Do not
25
+ build anything new on them; use the web editor, or the REST API directly.
26
+ """
27
+ from .builder import (
28
+ Agent,
29
+ Button,
30
+ Call,
31
+ Character,
32
+ Data,
33
+ DataSource,
34
+ DeployedCharacter,
35
+ Hook,
36
+ Identify,
37
+ Judgment,
38
+ Mirror,
39
+ Node,
40
+ OnApiPoll,
41
+ OnFace,
42
+ OnPlaybackDone,
43
+ OnSchedule,
44
+ OnSensor,
45
+ OnTimeout,
46
+ OnUtterance,
47
+ OnVision,
48
+ OnWebSocket,
49
+ OnWs,
50
+ Return,
51
+ Say,
52
+ Screen,
53
+ Script,
54
+ subflow,
55
+ )
56
+ from .client import MfaRequiredError, SocialRobotClient
57
+ from .runtime import ExternalStream, RobotSession, SubscribeStream
58
+
59
+ __version__ = "0.2.0"
60
+
61
+ # The PUBLIC surface: the runtime client only. Builder DSL names are
62
+ # imported above for in-repo tooling (seeds + e2e drivers) but are
63
+ # deliberately NOT listed here — `__all__` is what this package promises.
64
+ __all__ = [
65
+ "__version__",
66
+ "ExternalStream", "MfaRequiredError", "RobotSession", "SocialRobotClient", "SubscribeStream",
67
+ ]