docs python: python.buildEnv does not include buildPythonApplication modules

Clarify the issue encountered at
https://github.com/NixOS/nixpkgs/issues/45503
This commit is contained in:
Frederik Rietdijk 2018-08-26 09:31:39 +02:00
parent 07ea150b5c
commit b7e0c40d29

View File

@ -645,9 +645,15 @@ in python.withPackages(ps: [ps.blaze])).env
#### `buildPythonApplication` function
The `buildPythonApplication` function is practically the same as `buildPythonPackage`.
The difference is that `buildPythonPackage` by default prefixes the names of the packages with the version of the interpreter.
Because this is irrelevant for applications, the prefix is omitted.
The `buildPythonApplication` function is practically the same as
`buildPythonPackage`. The main purpose of this function is to build a Python
package where one is interested only in the executables, and not importable
modules. For that reason, when adding this package to a `python.buildEnv`, the
modules won't be made available.
Another difference is that `buildPythonPackage` by default prefixes the names of
the packages with the version of the interpreter. Because this is irrelevant for
applications, the prefix is omitted.
#### `toPythonApplication` function