automate UML diagrams

[williambdean]

Closes #178

---

📚 Documentation preview 📚: https://causalpy--395.org.readthedocs.build/en/395/

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.35%. Comparing base (77058ee) to head (59a4624). Report is 141 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #395      +/-   ##
==========================================
+ Coverage   85.60%   94.35%   +8.75%     
==========================================
  Files          22       30       +8     
  Lines        1716     1967     +251     
==========================================
+ Hits         1469     1856     +387     
+ Misses        247      111     -136     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[williambdean]

Where does the pyreverse command come from? pylint, right? Is this part of either the environment or pyproject dependencies?

EDIT: Added to docs

[williambdean]

pre-commit.ci autofix

[williambdean]

Having some permission issues. Not sure what is up @drbenvincent Might have to alter the pymc-marketing one as well

[williambdean]

@drbenvincent do you allow bots in the code base? I am noticing that the precommit auto fix didnt make a commit either

[williambdean]

Can you check in https://github.com/pymc-labs/CausalPy/settings/actions that "Workflow permissions" include "Read and write permissions" @drbenvincent

[drbenvincent]

Sorry for delay. Will focus on this ASAP.

[williambdean]

Had some issues in pymc marketing https://github.com/pymc-labs/pymc-marketing/pull/913

[drbenvincent]

Can you check in https://github.com/pymc-labs/CausalPy/settings/actions that "Workflow permissions" include "Read and write permissions" @drbenvincent

Current settings are as below. Let me know if I need to update anything.

[williambdean]

Can you check in https://github.com/pymc-labs/CausalPy/settings/actions that "Workflow permissions" include "Read and write permissions" @drbenvincent

Current settings are as below. Let me know if I need to update anything.

Thanks for checking this @drbenvincent

I was able to figure it out. Based on it coming from a fork.

Waiting for passing then can add back commented code

[williambdean]

Thoughts on the options: Run only on:

1. on all pushes, if the repo owner is pymc-labs (not run during forks) but then also on merge to main
2. merge to main

In either way, it will be updated.

What are your thoughts?

Here is the other option: https://github.com/pymc-labs/pymc-marketing/pull/967#issuecomment-2305913937

[williambdean]

This has deviated a bit from how it is (tried) to be done in PyMC-Marketing:

• file: https://github.com/pymc-labs/pymc-marketing/blob/main/.github/workflows/uml.yml
• runs: https://github.com/pymc-labs/pymc-marketing/actions/runs/13497681727