Skip to content

Commit 784c9c3

Browse files
authored
chore: add package initializer exporting public API and versions (v0.1.0)
1 parent 217dd92 commit 784c9c3

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

src/ohip/__init__.py

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
"""
2+
IX-HapticSight — Optical-Haptic Interaction Protocol (OHIP)
3+
4+
Package initializer: exposes the stable public API used across docs, sims,
5+
and tests. Keeps versioning centralized.
6+
7+
Versioning
8+
----------
9+
__version__ : project/package version (v0.1.0 for the v0.1 spec drop)
10+
__schema_version__ : canonical schema version from ohip.schemas
11+
12+
Do not import heavy dependencies here. Keep imports shallow.
13+
"""
14+
15+
from .schemas import (
16+
# enums
17+
SafetyLevel, HazardClass, ConsentMode, ConsentSource, NudgeLevel,
18+
# primitives
19+
Vector3, RPY, Pose,
20+
# core messages
21+
ConsentRecord, SafetyMapCell, Nudge,
22+
ImpedanceProfile, ContactPlan, ContactExecutionLog,
23+
RestTargets,
24+
# utils
25+
now_utc_iso, clamp, validate_priority,
26+
# schema version
27+
OHIP_SCHEMAS_VERSION as __schema_version__,
28+
)
29+
30+
from .nudge_scheduler import EngagementScheduler, PolicyProfile
31+
from .safety_gate import SafetyGate, HardwareInterface, HardwareStatusSnapshot
32+
from .contact_planner import ContactPlanner, PlannerHints
33+
from .rest_pose import RestPoseGenerator, RestConfig
34+
from .consent_manager import ConsentManager, ProfileRules
35+
36+
# Project/package version for this release of the reference implementation.
37+
__version__ = "0.1.0"
38+
39+
__all__ = [
40+
# versions
41+
"__version__", "__schema_version__",
42+
# enums & primitives
43+
"SafetyLevel", "HazardClass", "ConsentMode", "ConsentSource", "NudgeLevel",
44+
"Vector3", "RPY", "Pose",
45+
# core messages
46+
"ConsentRecord", "SafetyMapCell", "Nudge",
47+
"ImpedanceProfile", "ContactPlan", "ContactExecutionLog",
48+
"RestTargets",
49+
# utils
50+
"now_utc_iso", "clamp", "validate_priority",
51+
# scheduler
52+
"EngagementScheduler", "PolicyProfile",
53+
# safety
54+
"SafetyGate", "HardwareInterface", "HardwareStatusSnapshot",
55+
# planner
56+
"ContactPlanner", "PlannerHints",
57+
# rest pose
58+
"RestPoseGenerator", "RestConfig",
59+
# consent
60+
"ConsentManager", "ProfileRules",
61+
]

0 commit comments

Comments
 (0)