Add `update()` call when importing templateflow

templateflow / python-client

A python client to query TemplateFlow via pyBIDS

https://templateflow.org/python-client/

Apache License 2.0

8 stars 12 forks source link

Add `update()` call when importing templateflow #44

Closed mgxd closed 4 years ago

mgxd commented 4 years ago

To greatly simplify users updating their templateflow skeletons as templates are added / change.

stick a call to templateflow.conf.update() in templateflow.__init__.py
allow users to freeze current skeleton by setting environmental variable, i.e. TEMPLATEFLOW_AUTOUPDATE=0
fail gracefully and inform users when trying and failing to update skeleton

oesteban commented 4 years ago

I would add to this:

remove the post-installation hook

oesteban commented 4 years ago

BTW the call should be templateflow.conf.update(local=True, overwrite=False)

If a skeleton needs to be upgraded, then that should be done intentionally by the user (or fMRIPrep) with templateflow.conf.update(local=False, overwrite=False)

mgxd commented 4 years ago

If a skeleton needs to be upgraded, then that should be done intentionally by the user (or fMRIPrep) with templateflow.conf.update(local=False, overwrite=False)

This just bit me in https://github.com/poldracklab/fmriprep-rodents/pull/10/commits/a6bd87fcf1c0aed3bdade807b97def71a597947c. It should be easy for users to ensure they are working with the latest templates, WDYT about adding a flag (maybe --fetch-latest-templates) to allow users to run an update with overwrite=True?

mgxd commented 4 years ago

Ah nevermind, this is #58