search

OverLordGoldDragon / ssqueezepy

Synchrosqueezing, wavelet transforms, and time-frequency analysis in Python
MIT License
618 stars 96 forks source link

Added setup.py #12

Closed bluenote10 closed 3 years ago

bluenote10 commented 3 years ago

So far the package isn't really pip installable due to lack of a setup.py. I thought I'd add something basic to get you started, including properly specifying dependencies.

I guess few people in the Python community actually download releases from GitHub. So I guess you can safe you some time, and simply add a pip + git based installation instruction to the README like:

pip install git+https://github.com/OverLordGoldDragon/ssqueezepy

I could also help with publishing to PyPI in the long term.

OverLordGoldDragon commented 3 years ago

Thanks; I can do pip anytime, but figured I'd delay it until first release. As it's currently not my top priority, do you suggest I just push out the pre-release to pip? Unsure if cloning is somehow troublesome to users.

OverLordGoldDragon commented 3 years ago

Right, we'll need requirements for pip-based cloning to work, and in general; I'll get to it.

bluenote10 commented 3 years ago

Unsure if cloning is somehow troublesome to users.

Basically it implies that users work with the latest HEAD of master for now, which should be a sensible solution at this pre-release stage. The only crucial thing is to have some kind of setup.py, because without one I couldn't use the library in a venv at all.

Pushing to PyPI mainly becomes relevant in the long term to have explicit version control.

OverLordGoldDragon commented 3 years ago

Added a bunch of stuff; does it work now?

bluenote10 commented 3 years ago

Yes, looks very good, thanks! This is probably no longer needed then.