Skip to content

API update - #956

Merged
maddenp-cu merged 7 commits into
ufs-community:mainfrom
maddenp-cu:api-update
Jul 27, 2026
Merged

API update#956
maddenp-cu merged 7 commits into
ufs-community:mainfrom
maddenp-cu:api-update

Conversation

@maddenp-cu

Copy link
Copy Markdown
Collaborator

Synopsis

  • Expose uwtools.drivers.stager.FileStager via the API as uwtools.api.driver.FileStager to support apps creating external drivers using this abstract mixin.
  • Expose uwtools.utils.processing.run_shell_cmd via the API as uwtools.api.utils.run_shell_cmd, and make the docstring more useful for end users.
  • Update the documentation, including adding an API page for the new uwtools.api.utils.

Type

  • Documentation
  • Enhancement (adds new functionality)

Impact

  • This is a non-breaking change (existing functionality continues to work as expected)

Checklist

  • I have added myself and any co-authors to the PR's Assignees list.
  • I have reviewed the documentation and have made any updates necessitated by this change.
  • Where helpful, I have written comments in this PR's Files changed view to assist reviewers.

@maddenp-cu maddenp-cu self-assigned this Jul 27, 2026
@maddenp-cu
maddenp-cu marked this pull request as ready for review July 27, 2026 18:53

@christinaholtNOAA christinaholtNOAA left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One very minor semantics comment that I'll let you make the call on, but otherwise this looks great!

Comment thread src/uwtools/drivers/stager.py Outdated
@maddenp-cu
maddenp-cu merged commit eed39e4 into ufs-community:main Jul 27, 2026
2 checks passed
@maddenp-cu
maddenp-cu deleted the api-update branch July 27, 2026 20:20
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

Successfully merging this pull request may close these issues.

3 participants