Metadata-Version: 2.4
Name: spatial-web-sdk
Version: 0.1.0
Summary: Python SDK for the IEEE 2874-2025 Spatial Web standard (HSML/HSTP)
Project-URL: Homepage, https://github.com/akinj/spatial-web-sdk
Project-URL: Documentation, https://github.com/akinj/spatial-web-sdk#readme
Project-URL: Issues, https://github.com/akinj/spatial-web-sdk/issues
License: Apache-2.0
Keywords: AI-agents,HSML,HSTP,IEEE-2874,IoT,digital-twin,hyperspace-modeling-language,hyperspace-transaction-protocol,spatial-web,spatial-web-protocol
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# spatial-web-sdk

Python SDK for the **IEEE 2874-2025 Spatial Web standard** — the first open-source implementation of HSML (Hyperspace Modeling Language) and HSTP (Hyperspace Transaction Protocol).

## About IEEE 2874-2025

IEEE 2874-2025 is the Spatial Web Protocol, Architecture and Governance standard, ratified May 29, 2025. It defines:

- **HSML** — Hyperspace Modeling Language: a human- and machine-readable semantic modeling language for describing entities (people, places, things, AI agents) and their relationships
- **HSTP** — Hyperspace Transaction Protocol: the protocol defining how Spatial Web entities interact, including spatial range queries, verifiable credentialing, and automated contracting
- **UDG** — Universal Domain Graph: the distributed metagraph of all Spatial Web relationships
- **Agent Framework** — governance and interoperability for autonomous AI agents

Described as the third foundational web protocol after TCP/IP (1970s) and HTTP/HTML (1990s).

## Status

**Pre-Alpha.** Core HSML entity serialization and HSTP query client are in active development.

## Planned Features

- `Entity` — HSML entity definition and JSON serialization
- `SpatialQuery` — HSTP spatial range query construction
- `SWID` — Spatial Web Identifier (`did:swid`) generation per W3C DID spec
- `UDGNode` — Local Universal Domain Graph node utilities
- Domain-specific ontology extensions (healthcare, manufacturing, energy)

## Installation

```bash
pip install spatial-web-sdk
```

## Quick Start (Coming Soon)

```python
from spatial_web_sdk import Entity, EntityType, SpatialQuery

entity = Entity(
    entity_type=EntityType.DEVICE,
    name="Sensor A1",
    location={"lat": 37.7749, "lon": -122.4194},
)

print(entity.to_hsml())   # HSML JSON document
print(entity.swid)         # did:swid:...
```

## Resources

- [IEEE 2874-2025 Working Group](https://sagroups.ieee.org/2874/)
- [Spatial Web Foundation](https://spatialwebfoundation.org)
- [W3C DID Core](https://www.w3.org/TR/did-core/)

## License

Apache 2.0
