Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #71716

Pip requirements: Machine-readable configuration versus human-audience documentation (was: using a new computer and bringing needed libraries to it)

Show key headers only | View raw

Ned Batchelder <ned@nedbatchelder.com> writes:

> Make a list of the packages you need.  Put it in a file called
> requirements.txt.  Then install them with:
>
>     $ pip install -r requirements.txt
>
> Keep that file up-to-date as you add new requirements.

Since these requirements are specifically for Python, more specifically
for Pip, and even more specifically are supposed to be in a
machine-readable foramt and not just an arbitrary free-form text
document, can we recommend instead some more specific filename?

‘requirements.txt’ is already used in many projects to document *for a
human reader* the project-wide requirements, not jsut for Python, and we
should not arrogate a general name like that to a specific tool like
Pip.

I'd recommend (and have already begun to use) the name
‘pip_requirements’ or the like. I know that there is heaps of
Pip-specific documentation out there already recommending the more
general name, but I'd like that to change.

-- 
 \             “I believe our future depends powerfully on how well we |
  `\     understand this cosmos, in which we float like a mote of dust |
_o__)                 in the morning sky.” —Carl Sagan, _Cosmos_, 1980 |
Ben Finney

Back to comp.lang.python | Previous | Next — Previous in thread | Find similar | Unroll thread

Thread

using a new computer and bringing needed libraries to it CM <cmpython@gmail.com> - 2014-05-17 16:53 -0700
  Re: using a new computer and bringing needed libraries to it Ned Batchelder <ned@nedbatchelder.com> - 2014-05-17 20:17 -0400
    Re: using a new computer and bringing needed libraries to it Rustom Mody <rustompmody@gmail.com> - 2014-05-17 20:29 -0700
      Re: using a new computer and bringing needed libraries to it Ben Finney <ben@benfinney.id.au> - 2014-05-18 17:39 +1000
  Re: using a new computer and bringing needed libraries to it Terry Reedy <tjreedy@udel.edu> - 2014-05-17 20:29 -0400
  Re: using a new computer and bringing needed libraries to it Chris Angelico <rosuav@gmail.com> - 2014-05-18 10:30 +1000
  Pip requirements: Machine-readable configuration versus human-audience documentation (was: using a new computer and bringing needed libraries to it) Ben Finney <ben@benfinney.id.au> - 2014-05-18 12:01 +1000

csiph-web