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

Handle missing Graphviz in .workflow.make_click_command() #140

Open
khaeru opened this issue Dec 14, 2023 · 0 comments
Open

Handle missing Graphviz in .workflow.make_click_command() #140

khaeru opened this issue Dec 14, 2023 · 0 comments
Labels
doc Improvements or additions to documentation enh New features or functionality

Comments

@khaeru
Copy link
Member

khaeru commented Dec 14, 2023

This line:

if not go:
path = context.get_local_path(f"{slug}-workflow.svg")
wf.visualize(str(path))
log.info(f"Workflow diagram written to {path}")
return

…will error if the user has not installed Graphviz. (Note that the Python graphviz package is installed as a dependency, but the user must separately install Graphviz.)

We can:

  • Catch graphviz' ExecutableNotFoundError and continue; perhaps log an error with a pointer to the docs. This could also be done upstream, in genno.
  • Update the install docs and/or optional dependencies to include a recommendation and link to install Graphviz.

Noted today with @th-hara

@khaeru khaeru added doc Improvements or additions to documentation enh New features or functionality labels Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation enh New features or functionality
Projects
None yet
Development

No branches or pull requests

1 participant