This "issue" is more of an administrative log to help us manage the initial development of this project. We can close it and move this to other more appropriate management tools down the line. For now, I suggest the following target for ipyniivue-experimental based on the AnyWidget approach:
Develop a widget allowing us to replicate, in JupyterNotebook, with Python code, the demo already prepared for NiiVue. The functionalities must be usable from the Python side (i.e., we don't want just to be able to display JS demos in Jupyter Notebooks; we want to be able to implement them in Python using the JS wrapper). I suggest we implement these are different notebooks and cross them off the following list when done:
Besides ensuring these functionalities (and by integrating as notebooks ran by the CI on PR, ensuring that there is no code regression on these functionalities), I think we need to target the following objectives:
[ ] Every public class, function, class method, and class attribute has a doc string following pydocstyle
[ ] The code is PEP8 compliant the linting is automatically checked and enforced through CI on every PR
[ ] The documentation is automatically generated and pushed to a doc website (see hooks implemented for ipyniivue)
This "issue" is more of an administrative log to help us manage the initial development of this project. We can close it and move this to other more appropriate management tools down the line. For now, I suggest the following target for ipyniivue-experimental based on the AnyWidget approach:
Develop a widget allowing us to replicate, in JupyterNotebook, with Python code, the demo already prepared for NiiVue. The functionalities must be usable from the Python side (i.e., we don't want just to be able to display JS demos in Jupyter Notebooks; we want to be able to implement them in Python using the JS wrapper). I suggest we implement these are different notebooks and cross them off the following list when done:
Besides ensuring these functionalities (and by integrating as notebooks ran by the CI on PR, ensuring that there is no code regression on these functionalities), I think we need to target the following objectives:
Final objective: