Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
butler54 opened this issue Dec 8, 2021 · 1 comment

Comments

@butler54
Copy link
Collaborator

butler54 commented Dec 8, 2021

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.
@jpower432
Copy link
Member

@butler54 This could help create some boundaries for this proposal - oscal-compass/community#68. Should we close or keep this open?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants