nuclear-multimessenger-astronomy / nmma

A pythonic library for probing nuclear physics and cosmology with multimessenger analysis
https://nuclear-multimessenger-astronomy.github.io/nmma/
GNU General Public License v3.0
30 stars 58 forks source link

Replace setup.py with pyproject.toml #242

Closed mcoughlin closed 1 year ago

mcoughlin commented 1 year ago

This PR tries to replace setup.py with pyproject.toml.

sahiljhawar commented 1 year ago

LGTM. Resolves #241

sahiljhawar commented 1 year ago

@mcoughlin Sorry I didn't notice but all the entry points has been renamed. Should I change all of them?

mcoughlin commented 1 year ago

@sahiljhawar I think by convention, they should be "-" rather than "_"

sahiljhawar commented 1 year ago

yes, but this would mean that old workflow will be broken, those who are accustomed to do light_curve_analysis, etc

mcoughlin commented 1 year ago

@sahiljhawar I think we should make an announcement on list.

sahiljhawar commented 1 year ago

Okay! Docs needs to be updated as well.

tylerbarna commented 1 year ago

@mcoughlin @sahiljhawar once we update the docs, perhaps we should tag this as a new release? since this alters the way users interact with most of the functions

tylerbarna commented 1 year ago

It might also be worth (if possible) having some small period of deprecation where the old names are still callable to minimize compatibility issues with any users who updated without updating their existing codes that rely on nmma

sahiljhawar commented 1 year ago

But if we give the upgrade window, people will still be using the old names. How often do we seriosuly care about numpy or scipy deprecations?👀

mcoughlin commented 1 year ago

I think as long as we do a bump to 0.1.0 we can justify the change.

tylerbarna commented 1 year ago

I think as long as we do a bump to 0.1.0 we can justify the change.

that's a good point

tylerbarna commented 1 year ago

A bump to 0.1.0 may also be a good time to start doing release notes

mcoughlin commented 1 year ago

@sahiljhawar Can you write some release notes and then try a 0.1.0 release? I just pushed changes to the docs.

tylerbarna commented 1 year ago

@mcoughlin @sahiljhawar while we're at it, we may as well remove the KNTimeshift deprecation warning if we're upgrading to 0.1.0

relevant commit: 4e30aad18e3c8a88ed4bacb22cff75d75cc230c6

sahiljhawar commented 1 year ago

@tylerbarna Yes!

tylerbarna commented 1 year ago

@sahiljhawar just submitted #243 to address this