Consider moving reports to its own repository
#801
Comments
|
Assuming it is decided to break things out... Would it make sense to do it as a namespace package, so it would still be imported as We might be able to do something clever on our end, so that attempting to import without the package installed raises an informative error: >>> from bids import reports
ImportError("Please install the pybids-reports package with pip")That should help smooth out any transition, especially if you're able to maintain the API for a few versions at least. |
|
I like that idea! |
|
FYI: I will be playing around with using "mustache" templates to better separate code and boilerplate text in the report module. For now I am sandboxing things in this repo. https://github.com/Remi-Gau/bids-methods/blob/main/Demo.ipynb |
|
I've created https://github.com/bids-standard/pybids-reports and will try to get the packaging and current code cleaned up. |
The
reportsmodule is sort of disconnected from the rest ofpybids, and I was thinking that it might be a good idea to move it to its own package (e.g.,bids-standard/pybids-reports). I brought this idea up in today's BIDS maintainers meeting, and our decision was to open an issue to give users the opportunity to weigh in on this idea.A bit of context:
reportscurrently adds isnum2words, but @Remi-Gau has proposed using a templating tool to build reports in the future.reportsmodule is not commonly used, so I assume that removing it frompybidswon't cause any major problems for users. Please feel to comment here if that's not the case.pybidsas a dependency.The text was updated successfully, but these errors were encountered: