Status: New
Owner: ----
Labels: Type-Defect Priority-Medium
New issue 23 by
ianozsv...@gmail.com: Adding a requirements.txt file will
ease installation with pip
http://code.google.com/p/glumpy/issues/detail?id=23
This package lacks a requirements.txt file for the pip installer. The
requirements file makes it easy for a new user to setup the dependencies
using pinned (version-specified) copies of each library (rather than
defaulting to the latest version of each dependency which might introduce
unexpected bugs).
I've attached a working requirements.txt file, here are some notes:
http://www.pip-installer.org/en/latest/requirements.html
To generate the requirements.txt file I use:
$ pip freeze > requirements.txt
The file is plain text, you could remove the lines that are only relevant
to the demos/ (Pillow for PIL, scipy).
To install the dependencies use:
$ pip install -r requirements.txt
Often a project just has one requirements file. Since you need PIL(/Pillow)
and scipy for the demos it might be nice to have 1 requirements file for
glumpy with the mandatory dependencies and an additional one with just
PIL/Pillow and scipy named requirements_demos.txt. The user could
optionally install the second requirements file if they're running the
demos (so they don't get the heavier PIL/scipy packages if they don't need
them).
This assumes that the user will have pip (and not easy_install [which I
believe is considered out of date]). pip works great with or without
virtualenvs.
I'm not sure if requirements.txt/pip can be used by setup.py (the whole
Python package installer world continues to confuse me). I think the easy
approach is to install the requirements and then run "python setup.py
install". See a simple README example here:
https://github.com/bear/python-twitter#building
Attachments:
requirements.txt 148 bytes