Configuration¶
whey-conda
is configured in the pyproject.toml
file defined in PEP 517 and PEP 518.
See also
The whey documentation
contains instructions for configuring whey
itself.
To enable whey-conda
, add the following lines to your pyproject.toml
file:
[tool.whey.builders]
binary = "whey_conda"
The whey-conda
-specific configuration is defined in the tool.whey-conda
table.
conda-channels
and conda-extras
can instead be defined in the tool.mkrecipe
table if you also use mkrecipe
.
[tool.whey-conda]
¶
All keys are optional.
- conda-description¶
Type: String
The description of the package.
You can use a single
%s
in the description, which will be substituted with the value of the description key frompyproject.toml
.The default value is
'%s'
.Example:
[tool.whey-conda] conda-description = "Fantastic Spam!"
- conda-channels¶
-
A list of required conda channels to build and use the package.
The default value is
[]
.Example:
[tool.whey-conda] conda-channels = [ "domdfcoding", "conda-forge", "bioconda",]
- conda-extras¶
Type: Array of strings or the strings
'all'
or'none'
.A list of extras (see optional-dependencies) to include as requirements in the Conda package.
The special keyword
'all'
indicates all extras should be included.The special keyword
'none'
indicates no extras should be included.
The default value is
'none'
.Examples:
[tool.whey-conda] conda-extras = [ "test", "doc",] [tool.whey-conda] conda-extras = "all"