python-soundfile icon indicating copy to clipboard operation
python-soundfile copied to clipboard

Breadcrumbs from old pysoundfile to python-soundfile are partially broken

Open mcclure opened this issue 2 years ago • 1 comments
trafficstars

I was recommended PySoundFile in a StackOverflow post.

I was recommended "PySoundFile", at this address: https://pypi.org/project/PySoundFile/ That page links to these docs: https://pysoundfile.readthedocs.io/en/latest/# And this github: https://github.com/bastibe/PySoundFile

This is incorrect, I should be using python-soundfile with this pypi address https://pypi.org/project/soundfile/ and these docs https://python-soundfile.readthedocs.io/en/0.11.0/#module-soundfile . The other repo is an old version. But it took me about a day to figure that out, and once I figured it out it was harder than it could have been to find the "real" repo/project.

Things that would help:

  • The https://pypi.org/project/PySoundFile page could link to https://pypi.org/project/soundfile , but currently doesn't (or explain that you are looking at a deprecated library).
  • The https://pysoundfile.readthedocs.io/en/latest/# page could link to the pypi page or the updated docs, but currently doesn't (or explain that you are looking at a deprecated library)
  • The old github https://github.com/bastibe/PySoundFile does explain you are looking at a deprecated library, and links to the updated version, but at the incorrect/404 URL http://soundfile.readthedocs.org/

Unfortunately, through no fault of yours, several Google searches that one would hope to lead one to the python-soundfile library instead lead to pysoundfile, so it would be helpful if old linked to new.

mcclure avatar Sep 24 '23 21:09 mcclure

Yes. Pysoundfile is outdated and deprecated. The problem is, in order to update the documentation on PyPi, I'd have to publish a new version, but I don't have the old build systems any more, so it's very hard to do that without breaking things.

I had the idea of uploading a new version of pysoundfile that's just a wrapper for python-soundfile, but this will likely break things for the remaining users of pysoundfile.

So I don't have a good solution for this. If you have a good idea for how to deal with this, I'm all ears.

bastibe avatar Sep 30 '23 11:09 bastibe