compliance-trestle icon indicating copy to clipboard operation
compliance-trestle copied to clipboard

Published 20 hours ago • verified publisher icon oscal-compass

Revise trestle project structure & documentation to clarify public vs private signatures.

Open butler54 opened this issue 3 years ago • 1 comments

Issue description / feature objectives

Currently trestle has most methods scoped publicly. This creates uncertainty around which methods are acceptable to change w/o breaking backwards compatibility.

Identify all critical public api signatures

  • OscalBaseModel
  • load distributed
  • repository api
  • CLI signatures
  • certain drawio and markdown apis and IO
  • load_distributed
  • trestle.oscal.*

Document these then:

  • Refactor exisiting code to 'hide' imports as appropriate from public consumptions.

butler54 avatar Dec 08 '21 00:12 butler54