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.

Sign up for GitHub

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

Jump to bottom

Automate UML image generation #211

Closed
drbenvincent opened this issue Mar 22, 2023 · 2 comments · Fixed by #886
Closed

Automate UML image generation #211

drbenvincent opened this issue Mar 22, 2023 · 2 comments · Fixed by #886
Labels
docs Improvements or additions to documentation good first issue Good for newcomers . Doesn't require extensive knowledge of the repo and package maintenance

Comments

@drbenvincent
Copy link
Contributor

#210 added UML diagrams to the CONTRIBUTING.md file.

At the moment these are manually generated, e.g.

pyreverse pymc_marketing/mmm -d docs/source/uml -f 'ALL' -o png -p mmm
pyreverse pymc_marketing/clv -d docs/source/uml -f 'ALL' -o png -p clv

I initially tried to automate this by placing these lines into the makefile, but that caused the remote build of the docs to fail.

We need to automate the generation of the latest UML diagrams. One idea would be to have this happen locally as a pre-commit check.
@drbenvincent drbenvincent added docs Improvements or additions to documentation maintenance labels Mar 22, 2023
@wd60622
Copy link
Contributor

wd60622 commented May 9, 2024

Is this still of interest? I'm guessing that the current diagram is very stale!

@wd60622 wd60622 mentioned this issue May 9, 2024
Closed
@drbenvincent
Copy link
Contributor Author

drbenvincent commented May 9, 2024 •
edited
Loading

Is this still of interest? I'm guessing that the current diagram is very stale!

I think we might be up to date, but not 100% sure on that. But it would be cool to automate it, yes. Not sure what the best trigger should be - if it's deterministic then I guess it doesn't matter if it's run much more frequently than it needs to be.

EDIT: Sorry I thought this was a comment on the CausalPy repo - I'm using the GitHub app on my phone. It probably is out of date. If you implement here, could you also do it for CausalPy?

@drbenvincent drbenvincent mentioned this issue Jul 16, 2024
Closed
@wd60622 wd60622 added the good first issue Good for newcomers . Doesn't require extensive knowledge of the repo and package label Jul 17, 2024
@drbenvincent drbenvincent mentioned this issue Jul 23, 2024
Merged
9 tasks
@wd60622 wd60622 linked a pull request Jul 30, 2024 that will close this issue
Automate UML creation #886
Merged
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Improvements or additions to documentation good first issue Good for newcomers . Doesn't require extensive knowledge of the repo and package maintenance
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Automate UML creation pymc-labs/pymc-marketing
2 participants
@drbenvincent @wd60622