feat: ability to download reports as pdf#33
Conversation
|
Core updates are about adding pdf export option to cli, increasing timeout to 120 seconds and updating the links to the dashboards. You can run it for instance with this command, that downloads all reports in yaml configuration and stores them in The other changes are 'just' to enable ruff, black and other linting/formatting tools to play nicely together and give you also an option to fix locally. |
+1. I was about to submit only one line change and yaml updates however somehow I was not able to get all the linters to agree. I'm more than happy to split this into 2 PRs (or two commits in this PR).
Will do.
Thank you! |
3853d2f to
c47ab45
Compare
|
I have reorganized commits into separate logical pieces ( There are still some formatting changes that |
It is already using 79.
Docformatter needs to be set to |
webbnh
left a comment
There was a problem hiding this comment.
This all looks good, once we settle this last detail:
Where do we stand with formatting docstrings to 79 characters instead of 88? I think ruff can do this (see doc-line-too-long (W505) and max-doc-length).
It is already using 79.
So, the approach is that we will run docformatter and its [tool.docformatter] specifies 79, and we will run ruff and it will ignore docstrings? If so, that works for me.
ruff can warn on those but not fix. docformatter cannot fix it neither:
[...]
Docformatter needs to be set to force-wrap mode.
I'm OK with requiring the developer to fix the warnings manually (docstrings are often fragile, especially if they contain any formatted items, and having to fight with the formatter is really unsatisfying).
I don't mind setting force wrap and 505 docstring length rule. The other option is to ignore it. What do you prefer?
If, as the code stands now, we get warnings on mis-formatted doc strings (including lines casually running over 79 characters) then I propose leaving it as is.
In which case, I think this PR is ready to merge...so long as you remember to revert the change in the reference to python_lint_and_test.yaml in .github/workflows/ci.yaml. 🙂
838bc7c to
4dd4040
Compare
4dd4040 to
ccdc5c4
Compare
|
Validated the fixes with previous force push and now removed temporary linting branch pointer. CI will fail, however that is expected and I'll merge. |
This PR does following:
You can run it for instance with this command, that downloads all reports in yaml configuration and stores them in a
reports-julyfolder that remains after execution:The other changes are to introduce
pre-commitand align local execution with CI execution to make it easier to use.