Consolidate 'search' and 'transfer' into a single Django app #34
Labels
Breaking Change
This change is backward incompatible and will require users to edit their portals
help wanted
Extra attention is needed
Originally, I conceived the portal to be composed of smaller standalone apps where developers would pick and choose which app best suited their needs. 'search' and 'transfer' would be completely decoupled apps and contain their own views, models, and templates and could be seamlessly combined with Django URLs. The actual framework turned out very different from that idealized conception.
A 'transfer' app with views and urls doesn't currently exist, as there hasn't been a need for a standalone transfer app. The current 'search' app directly integrates transfer functionality for both Globus Transfer and Preview. While the internal search/transfer components are fully decoupled, the out-of-the-box search portal depends heavily on transfer.
I propose getting rid of both
globus_portal_framework.search
andglobus_portal_framework.transfer
and combining them. This would cause breaking changes but make several things cleaner:override_settings
will work seamlessly again)utils.py
modules would be renamed to more sensicalsearch.py
,transfer.py
,preview.py
modulesThis would cause breaking changes for downstream projects that called into apps for specific functionality instead of using the top level includes. For example,
from globus_portal_framework.search.utils.default_search_mapper
instead offrom globus_portal_framework import default_search_mapper
The text was updated successfully, but these errors were encountered: