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

Refactor: make the grapher usable as a library #45

Open
haidaraM opened this issue Jul 20, 2020 · 5 comments
Open

Refactor: make the grapher usable as a library #45

haidaraM opened this issue Jul 20, 2020 · 5 comments

Comments

@haidaraM
Copy link
Owner

haidaraM commented Jul 20, 2020

I wrote most of the grapher almost 7 years ago in 2017 and lot of things happened since 😄

Currently, the Grapher is tightly coupled to the CLI. This makes it difficult to use it as a library inside another project. Also the Grapher is a little bit complicated: thinking of splitting it. I also want to make the graph customizable by not hardcoding the shapes, layout and make the post processor more extensible.

So this issue is here to track the related changes. The outcome of these changes will be the version v1.0.0 v2.0.0 of the grapher?

@haidaraM
Copy link
Owner Author

The code is now cleaner. Will update the Readme with an example to integrate this in an existing project. Meanwhile, you can take how the CLI works as an example.

@haidaraM
Copy link
Owner Author

haidaraM commented May 2, 2023

For those following this issue: while the code can be used in another project, keep in mind that the internal API is not stable yet. I will likely refactor the internal of the grapher in the following versions. The Parser should not change that much.

So expect some breaking changes in minor versions if you are using this project inside another. Make sure to pin the version.

@ShanePresley
Copy link

A renderer that dumps the output of the parser into json for consumption by third-party tools would be really useful.

@haidaraM
Copy link
Owner Author

@ShanePresley This should be doable. Let me track that as a separate feature request: #192

@haidaraM
Copy link
Owner Author

haidaraM commented Sep 5, 2024

@ShanePresley This should be doable. Let me track that as a separate feature request: #192

Will be released in the following days.

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