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

Export requires graphviz #35

Open
mochic opened this issue May 25, 2024 · 4 comments
Open

Export requires graphviz #35

mochic opened this issue May 25, 2024 · 4 comments
Milestone

Comments

@mochic
Copy link

mochic commented May 25, 2024

For some operating systems graphviz may not already be installed. It might be helpful for future users to have a note that they need that in the README as the error raised is informative but doesnt explicitly say "graphviz" anywhere in it and may confuse future users.

@bruno-f-cruz
Copy link
Collaborator

I think the core functionality should be independent of graphviz for sure (this was raised a few times during development). I do agree that this dependency is not explicitly stated tho. How would you feel about adding a new dependency tag to the project.toml file that includes erdantic and graphviz, and try to catch errors when calling methods that expect this lib to be installed? Would this suffice?

@mochic
Copy link
Author

mochic commented May 25, 2024

Yeah this sounds good. Exporting diagrams is an amazing feature. We can still use most functionality of the library by validating via just the base model validation. Any sort of documentation on why the export fails for this reason seems useful, raising specific errors makes it easier on end users I suppose, I just don't want to bog you down with these kinda smallish issues. Also, this issue existing also serves as documentation.

@bruno-f-cruz
Copy link
Collaborator

After taking a second look into this, I think we should probably use the python wrapper package PyGraphViz as it provides better syntax and makes versioning dependencies much easier for us. Thoughts @jwong-nd?

@jwong-nd
Copy link
Collaborator

Looks promising, I can try a build on a separate branch.

@bruno-f-cruz bruno-f-cruz added this to the Next release milestone Jun 4, 2024
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

3 participants