Skip to content

Allow CLI use without ecFlow installed - #965

Merged
elcarpenterNOAA merged 14 commits into
ufs-community:mainfrom
elcarpenterNOAA:pypi-poc
Aug 18, 2026
Merged

Allow CLI use without ecFlow installed#965
elcarpenterNOAA merged 14 commits into
ufs-community:mainfrom
elcarpenterNOAA:pypi-poc

Conversation

@elcarpenterNOAA

Copy link
Copy Markdown
Collaborator

Synopsis

  • Detect whether the ecFlow API is importable, only add the ecflow mode when it is available, and lazily import uwtools.api.ecflow from ecFlow-specific functions.
  • Add an informative ImportError when uwtools.ecflow is imported without the library available.

Type

  • Bug fix (corrects a known issue)
  • Code maintenance (refactoring, etc. without behavior change)
  • Documentation
  • Enhancement (adds new functionality)
  • Tooling (CI, code-quality, packaging, revision-control, etc.)

Impact

  • This is a breaking change (changes existing functionality)
  • 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.

@elcarpenterNOAA elcarpenterNOAA self-assigned this Aug 18, 2026
Comment thread src/uwtools/tests/test_cli.py
Comment thread src/uwtools/tests/test_ecflow.py Outdated
Comment thread src/uwtools/cli.py Outdated
Comment thread src/uwtools/cli.py
@elcarpenterNOAA
elcarpenterNOAA marked this pull request as ready for review August 18, 2026 17:06
Comment thread docs/sections/user_guide/installation.rst Outdated
Comment thread src/uwtools/cli.py Outdated
Comment thread src/uwtools/cli.py Outdated
Comment thread src/uwtools/ecflow.py
Comment thread src/uwtools/tests/test_cli.py
Comment thread src/uwtools/tests/test_ecflow.py Outdated
@elcarpenterNOAA
elcarpenterNOAA merged commit d96c577 into ufs-community:main Aug 18, 2026
2 checks passed
@elcarpenterNOAA
elcarpenterNOAA deleted the pypi-poc branch August 18, 2026 19:42
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.

2 participants