Skip to content

Repository files navigation

OpenBIM.rs bSDD

CI crates.io docs.rs MSRV

A standalone Rust workspace reserving the OpenBIM.rs package names for a possible future integration with the buildingSMART Data Dictionary (bSDD).

Important

Version 0.1.0 is a reserved scaffold only. It does not provide a bSDD API client, request or response models, authentication, data validation, or conformance guarantees. Package-name ownership must not be read as a claim of bSDD functionality.

Capability status

Capability Status
Standalone Rust 2021 package-name scaffold Present
Lockstep canonical and pure-alias package layout Present and structurally gated
bSDD API HTTP client Not implemented
bSDD request/response data model Not implemented
Authentication or dictionary publishing Not implemented
Validation or conformance checking Not implemented
Offline cache or vendored dictionary data Not implemented

Package architecture

Package Role
openbim-bsdd Canonical reserved scaffold; the only package in which future implementation may live
bsdd Exact-version pure re-export alias; defines no independent API or types
bsdd  -- exact =0.1.0 dependency -->  openbim-bsdd
(alias; no implementation)           (canonical reserved scaffold)

Cargo permits dependency renaming but crates.io has no publisher-side package alias. The two package records reserve both names while bsdd re-exports the canonical crate, preserving one source for any future API.

Install

Choose one package name (do not add both directly):

cargo add openbim-bsdd@0.1.0
# or
cargo add bsdd@0.1.0

The only current item is a status marker:

assert!(openbim_bsdd::PACKAGE_STATUS.contains("reserved scaffold"));

Official bSDD resources

This project is independent of buildingSMART International. Authoritative bSDD product and API information belongs to buildingSMART:

No standards text, API snapshots, schemas, or dictionary exports are vendored in this repository.

Development

Rust 1.85.0 is the minimum supported version. Python 3.10 or newer is used by the semantic alias-purity gate.

git clone https://github.com/openbimrs/bsdd.git
cd bsdd
./scripts/gate.sh

The gate checks formatting, build, tests, Clippy, rustdoc, mutation-verified alias purity, and complete package archives for both crates.

See the architecture notes and contribution guide.

License

AGPL-3.0-or-later — see LICENSE.

About

Reserved pure-Rust bSDD package namespace and API-client roadmap for OpenBIM.rs.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages