You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Reorganizing module hierarchy structure to remove ODM2 folder #146
There's one issue that I think needs to be discussed soon, before odm2api can be seen as really stable. Currently the package has a packager/folder hierarchy that includes a now-useless "ODM2" folder: https://github.com/ODM2/ODM2PythonAPI/tree/master/odm2api/ODM2
That forces most module import statements to include the useless ODM2 package hierarchy (eg, odm2api.ODM2.services.readService). We'll need to get rid of the ODM2 folder hierarchy, and the sooner we do it the better, to minimize disruptions. I strongly recommend that we do it in the next release, giving ourselves plenty of time for all code that uses odm2api to make the adjustment.
Anthony:
I'm very much a fan of moving forward soon with the next release to remove the useless "ODM2" level of hierarchy (clipped unrelated comment). With release v0.7 minted as is, any software that depends on the old conventions still have handy access to that version, while we can move forward with migrating our actively developed stuff to our widespread conventions.
@lsetiawan, a question about the sphinx documentation: what happens once we merge your PR #146 (assuming it does what we want), in terms of the API Sphinx documentation? Now there'll be two valid module paths, one with the ODM2 path/package component, one without. Can we choose which one to show in the API documentation?
For reference, here's the API doc for readService, which currently has the module path odm2api.ODM2.services.readService. The new path would be odm2api.services.readService, but the old one will still work.
changed the title [-]Reorganizing module hiearchy structure to remove ODM2 folder[/-][+]Reorganizing module hierarchy structure to remove ODM2 folder[/+]on Mar 4, 2018
I'm reopening this issue as a reminder that in a future release (date TBD), we'll remove support for the now-deprecated "ODM2" package module hierarchy. That, import statements such as this one:
odm2api.ODM2.services.readService
will eventually no longer be supported, and only the new hiearchy will be supported:
Activity
emiliom commentedon Feb 17, 2018
@lsetiawan, a question about the sphinx documentation: what happens once we merge your PR #146 (assuming it does what we want), in terms of the API Sphinx documentation? Now there'll be two valid module paths, one with the
ODM2path/package component, one without. Can we choose which one to show in the API documentation?For reference, here's the API doc for
readService, which currently has the module pathodm2api.ODM2.services.readService. The new path would beodm2api.services.readService, but the old one will still work.lsetiawan commentedon Feb 17, 2018
For the sphinx, I'd probably have to update the
rstdocs. See https://github.com/ODM2/ODM2PythonAPI/blob/master/docs/source/modules.rst. We would like to show the new ones correct? I'm not sure how the old one will render in the documentation. Thanks.emiliom commentedon Feb 17, 2018
Ok. So we control that. Cool.
Exactly
lsetiawan commentedon Feb 28, 2018
Done in #147. Closing.
emiliom commentedon Feb 28, 2018
Thanks for closing.
I guess regarding the docs:
The updates should be done only when issue a new release.
lsetiawan commentedon Feb 28, 2018
I can update that now, so it will be included in the new release.
emiliom commentedon Feb 28, 2018
Great, thanks.
[-]Reorganizing module hiearchy structure to remove ODM2 folder[/-][+]Reorganizing module hierarchy structure to remove ODM2 folder[/+]emiliom commentedon Mar 4, 2018
I'm reopening this issue as a reminder that in a future release (date TBD), we'll remove support for the now-deprecated "ODM2" package module hierarchy. That, import statements such as this one:
will eventually no longer be supported, and only the new hiearchy will be supported:
emiliom commentedon Apr 28, 2019
Note to self: Make sure to read #159 for "definitive" findings about the preservation of git history after the module moves.