Replace ~/omero with standard OS-dependent paths

manics commented 4 years ago

Replaces ~/omero with "standard" paths according to each operating system: https://pypi.org/project/appdirs/

Closes https://github.com/ome/omero-py/issues/210

manics commented 4 years ago

Is this considered a breaking change that should wait for 6.0.0?. If so this could be split so only omero.util.get_omero_user_cache_dir() which was added in #162 uses the new paths

sbesson commented 4 years ago

Few immediate thoughts:

agreed the changes are not breaking the API although we might want to review the impact of such a change
I suspect we will need to consider the case where downstream applications are accessing application data and moving away from ~/omero would break the expectations. In that sense, I think the delineation proposed in https://github.com/ome/omero-py/pull/233#issuecomment-656303819 is probably an acceptable compromise as anything stored in a cache directory should be considered as potentially transient
more generally, do you have some mechanism that would allow the migration of data between the old user/cache directory and the new one
the application specific aspect of the paths also raises the questions of the unification with other OMERO clients e.g. OMERO.insight is using ~/omero/log

manics commented 4 years ago

I'll rebase on top of https://github.com/ome/omero-py/pull/240

ome / omero-py

Replace ~/omero with standard OS-dependent paths #233