Add pip requirements file.
seanfisk opened this issue · 1 comments
In #3, we decided to take out the runtime requirements.txt file in favor of having libraries in the setup.py file. However, I've been doing some reading on pip requirements files and have a new idea for what they are actually used.
According to the aforementioned docs, the requirements.txt file should be used to create a completely reproducible environment, and these steps should be followed for reproducibility. Ian Bicking (author of pip) mentions in this StackOverflow response that "install_requires is to keep people away from things that you know don't work, while requirements files to lead people towards things you know do work."
What I'm planning to do is create a clean virtual environment and generate a requirements.txt using pip freeze. I will also add a section to the README explaining the difference between requirements files and install_requires. Opinions welcome.