Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename repository and PyPI package to ebrains-storage #16

Open
apdavison opened this issue Aug 30, 2022 · 7 comments
Open

Rename repository and PyPI package to ebrains-storage #16

apdavison opened this issue Aug 30, 2022 · 7 comments

Comments

@apdavison
Copy link
Member

Since this package now supports both the Drive and Bucket services, it might be less confusing for users if we rename it to "ebrains-storage".

The downside is that people using the package will have to update their code, otherwise they will not get the latest version. We should in case of a rename add a deprecation warning if people "import ebrains_drive"

@xgui3783
Copy link
Contributor

I have no opinion about either keeping the name or renaming the package.

perhaps worth considering, if we choose to move ahead with releasing packages under a new name:

  • rename repository from humanbrainproject/ebrains-drive -> humanbrainproject/ebrains-storage (or leave this one be, but mark as deprecated, and create fork/new repo?)
  • make one final release of ebrains-drive (0.5.1) showing deprecation notice. Deprecate ebrains-drive on pypi

@apdavison
Copy link
Member Author

for renaming the repository it's not necessary to create a new fork/repo, as Github will redirect the old name to the new, indefinitely.

@apdavison
Copy link
Member Author

for the Python package, apparently there's a trick: in setup.py for ebrains-drive we should add install_requires=["ebrains-storage"], so if anyone tries pip install ebrains-drive, then ebrains-storage will get installed - see https://github.com/simonw/pypi-rename and https://stackoverflow.com/questions/61363534/whats-the-recommended-way-of-renaming-a-project-in-pypi

@appukuttan-shailesh
Copy link
Collaborator

appukuttan-shailesh commented Aug 30, 2022

Won't users still need to update their existing scripts to have the new 'import' statements? If so, do we really need to do the above (install_requires=["ebrains-storage"]), as they anyways would need to be made aware of the change? We could just go with the deprecation warning, and direct them to install the new package?

@apdavison
Copy link
Member Author

apdavison commented Aug 30, 2022

@appukuttan-shailesh the idea is that users who do not update their import statements will nevertheless get the new package. i.e. ebrains-drive will be a stub package that imports from ebrains-storage

@maedoc
Copy link

maedoc commented Sep 21, 2022

It is much better to change now when fewer lines of code have been written rather than more, and the more general name invites broader scope of contributions.

@Cracky5457
Copy link
Collaborator

Hello, I agree that ebrains-storage is definitely a better name now that we have bucket included, and maybe in the future an other storage.

Not sure I will have some time for that during the next week but it's a good idea !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants