marl / pysox

Python wrapper around sox.
BSD 3-Clause "New" or "Revised" License
517 stars 80 forks source link

Tagged releases are out of sync with PyPi #148

Closed jgarte closed 8 months ago

jgarte commented 2 years ago

Hi, is it possible to tag releases here so they are in sync with the version that's on PyPi?

This would help avoid confusion when packaging for distros.

https://issues.guix.gnu.org/49469

lostanlen commented 2 years ago

Hello, what should we do exactly?

jgarte commented 2 years ago

Hello, what should we do exactly?

  1. Add the data files folder for tests on PyPi. PyPi includes the test folder but without the data files folder tests fail.

  2. The version on PyPi should be the same as the version on the github releases. Version on PyPi is 1.4.1 and version on github releases is outdated at 0.4.0

lostanlen commented 2 years ago
  1. it's not obvious that we should do this. PyPI releases are application-oriented and typically do not include unit tests at all. If you need to run your own unit tests, you can use the GitHub link.

  2. this is indeed a problem. I need the opinion of original maintainer @rabitt as to what to do. Possible release a 1.5.0 both on GitHub and PyPI?

jgarte commented 2 years ago

Thanks for the reply.

  1. it's not obvious that we should do this. PyPI releases are application-oriented and typically do not include unit tests at all. If you need to run your own unit tests, you can use the GitHub link.

Then the test folder should probably be removed from the PyPi tarball since it will fail without the data folder containing the audio files. It becomes confusing to have it there unless upstream is expecting the users to run a subset of tests that don't use the audio files for testing?

  1. ... Possible release a 1.5.0 both on GitHub and PyPI?

Yup. Just to have them in sync with each other.

lostanlen commented 2 years ago

Agreed with 1. We need green light from @rabitt for 2.

rabitt commented 2 years ago

Agreed with 1. We need green light from @rabitt for 2.

I'm OK with a 1.5.0 release to sync the two. I have on my backlog to set up GH actions to automatically push pypi releases when a github release is tagged which should solve this problem moving forward.

lostanlen commented 8 months ago

1.5.0-rc1 is out on PyPI https://pypi.org/project/sox/1.5rc1/