WarrenWeckesser / wavio

A Python module for reading and writing WAV files using numpy arrays.
133 stars 19 forks source link

Adding __init__.py file #1

Closed sg3510 closed 9 years ago

sg3510 commented 9 years ago

As discussed here it would be nice to be able to use wavio as a submodule and not have to use sys.path.append (which can sometimes cause problems with relative paths if the module importing wavio itself is imported).

WarrenWeckesser commented 9 years ago

@sg3510, thanks for the pull request.

Adding __init__.py in the top-level source directory is not the right way to handle this. For a tiny module such as wavio, I don't recommend using a git submodule. The python module is a single file, wavio.py, and--although I did make a small change today--I don't expect it to change much. It's fine with me if you simply copy the file and check it in as part of your project.

Another approach would be for me to put wavio on PyPI. Then you could add it to your project dependencies. I haven't done that, because I've thought of this code as a temporary work-around to scipy's lack of support for 24 bit files. The code started out as an answer to a question on stackoverflow, and then spent a long time as a gist on github. It would probably still be a gist, but after making a few changes to it, I realized the github API for a real repo was much nicer. Eventually scipy should support 24 bit files, and wavio will become obsolete. In the meantime, I'm fine with anyone simply copying the main file, wavio.py, into their own projects.

If you prefer to maintain the git submodule, you could hack sys.path (not recommended), or add some code to your setup.py script to install wavio into a directory that is in the search path.

WarrenWeckesser commented 8 years ago

Update: I ended up putting wavio on PyPI: https://pypi.python.org/pypi/wavio