Use setuptools for plugin mechanism. #72
Conversation
…We run those tools in other parts of our testing pipeline and use different flags.
… directly in README now.
…rectory as they interfere with those from main Statick repo.
…any issues with type hints and unit tests.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #72 +/- ##
===========================================
- Coverage 97.46% 29.01% -68.45%
===========================================
Files 7 6 -1
Lines 276 224 -52
===========================================
- Hits 269 65 -204
- Misses 7 159 +152 ☔ View full report in Codecov by Sentry. |
xydesa
left a comment
xydesa
left a comment
There was a problem hiding this comment.
Can you update the changelog please? and include that proselint was removed.
|
There's something wrong with the code coverage when running tox locally in this branch. /home/axydes/code/github/statick_ws/statick-md/.tox/py310/lib/python3.10/site-packages/statick_tool/plugins/tool/writegood_tool_plugin.py 43 1 98% 44
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL 276 1 99%on this branch, none of the plugins Name Stmts Miss Cover Missing
----------------------------------------------------------------------------------------------------------------------------------------
/home/axydes/code/github/statick_ws/tdenewiler-statick-md/src/statick_tool/plugins/discovery/markdown.py 23 14 39% 17, 23-43
/home/axydes/code/github/statick_ws/tdenewiler-statick-md/src/statick_tool/plugins/discovery/rst.py 23 14 39% 17, 23-43
/home/axydes/code/github/statick_ws/tdenewiler-statick-md/src/statick_tool/plugins/tool/markdownlint.py 59 47 20% 18, 22, 29-78, 86-121
/home/axydes/code/github/statick_ws/tdenewiler-statick-md/src/statick_tool/plugins/tool/rstcheck.py 43 31 28% 18, 22, 29-58, 66-85
/home/axydes/code/github/statick_ws/tdenewiler-statick-md/src/statick_tool/plugins/tool/rstlint.py 33 22 33% 18, 23-45, 51-69
/home/axydes/code/github/statick_ws/tdenewiler-statick-md/src/statick_tool/plugins/tool/writegood.py 43 31 28% 21, 25, 32-64, 70-90
----------------------------------------------------------------------------------------------------------------------------------------
TOTAL 224 159 29% |
pyproject.toml
Outdated
| "restructuredtext-lint", | ||
| "rstcheck", | ||
| "sphinx", | ||
| "statick@git+https://github.com/tdenewiler/statick@stdlib-plugins", |
There was a problem hiding this comment.
| "statick@git+https://github.com/tdenewiler/statick@stdlib-plugins", | |
| "statick>=0.11.0" |
once that PR is merged and we have a new release.
There was a problem hiding this comment.
We need to update the dependency. I'm not sure we will have a 1.0.0 release right away. We might do a 0.11.0 tag first, and save 1.0.0 for after we move all our known plugins into the main repo.
There was a problem hiding this comment.
I like that plan. let's do 0.11.0 first, and then save 1.0.0 for when we move all the plugins into the main package.
I've been trying for about 6 months to fix code coverage with tox on the plugin repositories. I've given up. My proposed approach is to add |
oh yea, i remember talking about that with you. pytest is definitely calling into the functions, and the tests are passing. thanks for the reminder i'm ok with this as is. |
Done in beacbee. |
3 participants
Switch from yapsy to setuptools for creating plugins for discovery, reporting, and tools.