pip
| state: | released |
| maintainers: | @phaer |
Introduction¶
A module to package python projects via pip.
Under the hood, it uses ./pkgs/fetchPipMetadata to
run pip install --dry-run --report [...] with reproducible inputs and converts the resulting installation report into a dream2nix
lock file.
Note
Due to limitations in pips cross-platform support, the resulting
lock-files are platform-specific!
We therefore recommend setting paths.lockFile to lock.${system}.json
for all projects where you use the pip module.
Check out the pdm module if you need a solution that allows locking for multiple platforms at once!
During building, it uses this lock file to build each dependency as well as the top-level package in separate derivations while allowing overrides and further customization via dream2nix module system.
Getting started¶
See Build a python project with pip.
Options¶
pip¶
| type | submodule |
| source | dream2nix/modules/dream2nix/pip/pip-hotfixes/interface.nix, dream2nix/modules/dream2nix/pip/interface.nix |
pip.buildDependencies¶
python packages to be added only as buildInputs.
These should be somehow installable from requirementsList or
requirementsFiles too; listing them here doesn't do that automatically.
| type | attribute set of boolean |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | {
cython = true;
flit-core = true;
flit-scm = true;
hatch-fancy-pypi-readme = true;
hatch-nodejs-version = true;
hatch-vcs = true;
hatchling = true;
pbr = true;
pdm-pep517 = true;
poetry-core = true;
poetry-dynamic-versioning = true;
setuptools = true;
setuptools-odoo = true;
setuptools-scm = true;
versioneer = true;
wheel = true;
}
|
| example |
{
setuptools-scm = false; # To disable the default
easy_install = true; # To select easy_install as a buildInput
}
|
pip.buildExtras¶
list of python "extras" to build with. This can be a subset of the extras in your lock file.
| type | list of string |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | [ ]
|
pip.deps¶
All dependencies of the package. This option should be set by the "outer world" and can be used to inherit attributes from pkgs or inputs etc.
By separating the task of retrieving things from the outside world, it is ensured that the dependencies are overridable.
Nothing will stop users from adding nixpkgs itself as a dependency, but this will make it very hard for the user of the package to override any dependencies, because they'd have to figure out a way to insert their changes into the Nixpkgs fixpoint. By adding specific attributes to deps instead, the user has a realistic chance of overriding those dependencies.
So deps should be specific, but not overly specific. For instance, the caller shouldn't have to know the version of a dependency in order to override it. The name should suffice. (e.g. nix = nixVersions.nix_2_12 instead of inherit (nixVersions) nix_2_12.
| type | lazy attribute set of raw value |
| source | dream2nix/modules/dream2nix/core/deps |
| default | { }
|
| example |
{nixpkgs, ...}: {
inherit (nixpkgs) stdenv;
inherit (nixpkgs.haskellPackages) pandoc;
}
|
pip.editables¶
| type | attribute set of string |
| source | dream2nix/modules/dream2nix/python-editables/interface.nix |
pip.editablesDevShell¶
| type | package (read only) |
| source | dream2nix/modules/dream2nix/python-editables/interface.nix |
pip.editablesShellHook¶
| type | string (read only) |
| source | dream2nix/modules/dream2nix/python-editables/interface.nix |
pip.env¶
environment variables exported while locking
| type | attribute set of string |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | { }
|
| example |
{
PIP_FIND_LINKS = "${config.deps.setuptools.dist}";
}
|
pip.flattenDependencies¶
Use all dependencies as top-level dependencies
| type | boolean |
| source | dream2nix/modules/dream2nix/pip/pip-hotfixes/interface.nix |
| default | false
|
pip.ignoredDependencies¶
list of dependencies to ignore
| type | list of string |
| source | dream2nix/modules/dream2nix/pip/pip-hotfixes/interface.nix |
| default | [
"wheel"
]
|
pip.nativeBuildInputs¶
list of native packages to include during metadata generation
| type | list of package |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | [ ]
|
pip.overrideAll¶
Overrides applied on all dependencies.
| type | module |
| source | dream2nix/modules/dream2nix/overrides/interface.nix |
| default | { }
|
| example |
{
mkDerivation = {
doCheck = false;
};
}
|
buildPythonPackage¶
pip.overrideAll.buildPythonPackage.build-system¶
Build-time only Python dependencies. Items listed in build-system.requires/setup_requires.
| type | list of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.catchConflicts¶
Raise an error if two packages are installed with the same name TODO: For cross we probably need a different PYTHONPATH, or not add the runtime deps until after buildPhase.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | ''
true if the host and build platforms are the same, false otherwise.
''
|
pip.overrideAll.buildPythonPackage.dependencies¶
List of runtime python dependencies. Aside from propagating dependencies,
buildPythonPackage also injects code into and wraps executables with the
paths included in this list. Items listed in install_requires go here.
| type | list of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.disabled¶
used to disable derivation, useful for specific python versions
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
pip.overrideAll.buildPythonPackage.disabledTestPaths¶
Test paths to ignore in checkPhase
| type | list of anything |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.disabledTests¶
Disable running specific unit tests
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.dontUsePipInstall¶
Don't use Pip to install a wheel Note this is actually a variable for the pipInstallPhase in pip's setupHook. It's included here to prevent an infinite recursion.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
pip.overrideAll.buildPythonPackage.dontWrapPythonPrograms¶
Skip wrapping of python programs altogether
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
pip.overrideAll.buildPythonPackage.format¶
Several package formats are supported:
null: Disable this legacy option and use the new pyproject option instead.
"setuptools" : Install a common setuptools/distutils based package. This builds a wheel.
"wheel" : Install from a pre-compiled wheel.
"flit" : Install a flit package. This builds a wheel.
"pyproject": Install a package using a pyproject.toml file (PEP517). This builds a wheel.
"egg": Install a package from an egg.
"other" : Provide your own buildPhase and installPhase.
| type | null or string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | "setuptools"
|
pip.overrideAll.buildPythonPackage.makeWrapperArgs¶
Additional arguments to pass to the makeWrapper function, which wraps generated binaries.
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.optional-dependencies¶
Optional feature flagged dependencies. Items listed in extras_requires go here.
| type | attribute set of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | { }
|
pip.overrideAll.buildPythonPackage.permitUserSite¶
Skip setting the PYTHONNOUSERSITE environment variable in wrapped programs
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
pip.overrideAll.buildPythonPackage.pipInstallFlags¶
Extra flags passed to pip install
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.pyproject¶
Whether the pyproject format should be used. When set to true,
pypaBuildHook will be used, and you can add the required build dependencies
from build-system.requires to build-system.
Note that the pyproject format falls back to using setuptools, so
you can use pyproject = true even if the package only has a setup.py.
When set to false, you can use the existing hooks or provide your own
logic to build the package. This can be useful for packages that don't
support the pyproject format.
When unset, the legacy setuptools hooks are used for backwards compatibility.
| type | null or boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | null
|
pip.overrideAll.buildPythonPackage.pytestFlagsArray¶
Extra flags passed to pytest
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.pythonImportsCheck¶
Check whether importing the listed modules works
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
pip.overrideAll.buildPythonPackage.removeBinBytecode¶
Remove bytecode from bin folder.
When a Python script has the extension .py, bytecode is generated
Typically, executables in bin have no extension, so no bytecode is generated.
However, some packages do provide executables with extensions, and thus bytecode is generated.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | true
|
pip.overrideAll.deps¶
All dependencies of the package. This option should be set by the "outer world" and can be used to inherit attributes from pkgs or inputs etc.
By separating the task of retrieving things from the outside world, it is ensured that the dependencies are overridable.
Nothing will stop users from adding nixpkgs itself as a dependency, but this will make it very hard for the user of the package to override any dependencies, because they'd have to figure out a way to insert their changes into the Nixpkgs fixpoint. By adding specific attributes to deps instead, the user has a realistic chance of overriding those dependencies.
So deps should be specific, but not overly specific. For instance, the caller shouldn't have to know the version of a dependency in order to override it. The name should suffice. (e.g. nix = nixVersions.nix_2_12 instead of inherit (nixVersions) nix_2_12.
| type | lazy attribute set of raw value |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix, dream2nix/modules/dream2nix/core/deps, dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | { }
|
| example |
{nixpkgs, ...}: {
inherit (nixpkgs) stdenv;
inherit (nixpkgs.haskellPackages) pandoc;
}
|
pip.overrideAll.deps.python¶
The python interpreter package to use
| type | package |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
pip.overrideAll.deps.stdenv¶
The stdenv used for building this package
| type | raw value |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
pip.overrideAll.env¶
environment variables passed to the build environment
| type | attribute set of (null or boolean or signed integer or string or path or package or list of (boolean or signed integer or string or path or package)) |
| source | dream2nix/modules/dream2nix/core/env |
| default | { }
|
mkDerivation¶
pip.overrideAll.mkDerivation.__contentAddressed¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.__darwinAllowLocalNetworking¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.__impureHostDeps¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.__propagatedImpureHostDeps¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.__structuredAttrs¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.allowSubstitutes¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.allowedReferences¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.allowedRequisites¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.args¶
| type | null or (list of (string or path)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.buildFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.buildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.buildPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.builder¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.checkFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.checkInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.checkPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.checkTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.cmakeFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.configureFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.configurePhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.configurePlatforms¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.configureScript¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsBuildBuild¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsBuildBuildPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsBuildTarget¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsBuildTargetPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsHostHost¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsHostHostPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsTargetTarget¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.depsTargetTargetPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.disallowedReferences¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.disallowedRequisites¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.distFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.distPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.distTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.doCheck¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.doDist¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.doInstallCheck¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontAddDisableDepTrack¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontAddPrefix¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontAddStaticConfigureFlags¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontBuild¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontConfigure¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontCopyDist¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontDisableStatic¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontFixLibtool¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontFixup¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontInstall¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontMakeSourcesWritable¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontMoveBin¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontPatch¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontPatchELF¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontPatchShebangs¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontPruneLibtoolFiles¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontStrip¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontStripHost¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontStripTarget¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.dontUnpack¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.enableParallelBuilding¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.enableParallelChecking¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.exportReferenceGraph¶
| type | null or (list of (string or package)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.fixupPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.forceShare¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.hardeningDisable¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.hardeningEnable¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.impureEnvVars¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.installCheckFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.installCheckInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.installCheckPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.installCheckTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.installFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.installPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.installTargets¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.makeFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.makefile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.mesonFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.meta¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
pip.overrideAll.mkDerivation.nativeBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.nativeCheckInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.outputHash¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.outputHashAlgo¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.outputHashMode¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.outputs¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | [
"out"
]
|
pip.overrideAll.mkDerivation.passAsFile¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.passthru¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
pip.overrideAll.mkDerivation.patchFlags¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.patchPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.patches¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.phases¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.pos¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
pip.overrideAll.mkDerivation.postBuild¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postConfigure¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postDist¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postFixup¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postInstalCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postInstall¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postPatch¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.postUnpack¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preBuild¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preBuildPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preConfigure¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preConfigurePhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preDist¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preDistPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preFixup¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preFixupPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preInstall¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preInstallCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preInstallPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.prePatch¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.prePhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preUnpack¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.preferLocalBuild¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.prefix¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.prefixKey¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.propagatedBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.propagatedNativeBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.propagatedSandboxProfile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.realBuilder¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.requiredSystemFeatures¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.sandboxProfile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.separateDebugInfo¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.setSourceRoot¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.setupHook¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.shellHook¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.sourceRoot¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.src¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.srcs¶
| type | null or (list of (string or path or package)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.strictDeps¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.stripAllFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.stripAllList¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.stripDebugFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.stripDebugList¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.tarballs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.unpackCmd¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.unpackPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.mkDerivation.version¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrideAll.name¶
The name of the package
| type | string |
| source | dream2nix/modules/dream2nix/core/ui/interface.nix |
pip.overrideAll.public¶
The final result of the evaluated package.
Contains everything that nix expects from a derivation.
Contains fields like name, outputs, drvPath, outPath, etc.
Can be build with nix-build or nix build.
| type | lazy attribute set of anything |
| source | dream2nix/modules/dream2nix/core/public/interface.nix |
pip.overrideAll.version¶
The version of the package
| type | string |
| source | dream2nix/modules/dream2nix/core/ui/interface.nix |
pip.overrides¶
Overrides applied only on dependencies matching the specified name.
| type | attribute set of module |
| source | dream2nix/modules/dream2nix/overrides/interface.nix |
| default | { }
|
| example |
{
hello = {
mkDerivation = {
postPatch = ''
substituteInPlace Makefile --replace /usr/local /usr
'';
};
};
}
|
<name>¶
buildPythonPackage¶
# pip.overrides.<name>.buildPythonPackage.build-system¶
Build-time only Python dependencies. Items listed in build-system.requires/setup_requires.
| type | list of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.catchConflicts¶
Raise an error if two packages are installed with the same name TODO: For cross we probably need a different PYTHONPATH, or not add the runtime deps until after buildPhase.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | ''
true if the host and build platforms are the same, false otherwise.
''
|
# pip.overrides.<name>.buildPythonPackage.dependencies¶
List of runtime python dependencies. Aside from propagating dependencies,
buildPythonPackage also injects code into and wraps executables with the
paths included in this list. Items listed in install_requires go here.
| type | list of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.disabled¶
used to disable derivation, useful for specific python versions
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
# pip.overrides.<name>.buildPythonPackage.disabledTestPaths¶
Test paths to ignore in checkPhase
| type | list of anything |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.disabledTests¶
Disable running specific unit tests
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.dontUsePipInstall¶
Don't use Pip to install a wheel Note this is actually a variable for the pipInstallPhase in pip's setupHook. It's included here to prevent an infinite recursion.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
# pip.overrides.<name>.buildPythonPackage.dontWrapPythonPrograms¶
Skip wrapping of python programs altogether
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
# pip.overrides.<name>.buildPythonPackage.format¶
Several package formats are supported:
null: Disable this legacy option and use the new pyproject option instead.
"setuptools" : Install a common setuptools/distutils based package. This builds a wheel.
"wheel" : Install from a pre-compiled wheel.
"flit" : Install a flit package. This builds a wheel.
"pyproject": Install a package using a pyproject.toml file (PEP517). This builds a wheel.
"egg": Install a package from an egg.
"other" : Provide your own buildPhase and installPhase.
| type | null or string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | "setuptools"
|
# pip.overrides.<name>.buildPythonPackage.makeWrapperArgs¶
Additional arguments to pass to the makeWrapper function, which wraps generated binaries.
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.optional-dependencies¶
Optional feature flagged dependencies. Items listed in extras_requires go here.
| type | attribute set of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | { }
|
# pip.overrides.<name>.buildPythonPackage.permitUserSite¶
Skip setting the PYTHONNOUSERSITE environment variable in wrapped programs
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
# pip.overrides.<name>.buildPythonPackage.pipInstallFlags¶
Extra flags passed to pip install
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.pyproject¶
Whether the pyproject format should be used. When set to true,
pypaBuildHook will be used, and you can add the required build dependencies
from build-system.requires to build-system.
Note that the pyproject format falls back to using setuptools, so
you can use pyproject = true even if the package only has a setup.py.
When set to false, you can use the existing hooks or provide your own
logic to build the package. This can be useful for packages that don't
support the pyproject format.
When unset, the legacy setuptools hooks are used for backwards compatibility.
| type | null or boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | null
|
# pip.overrides.<name>.buildPythonPackage.pytestFlagsArray¶
Extra flags passed to pytest
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.pythonImportsCheck¶
Check whether importing the listed modules works
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
# pip.overrides.<name>.buildPythonPackage.removeBinBytecode¶
Remove bytecode from bin folder.
When a Python script has the extension .py, bytecode is generated
Typically, executables in bin have no extension, so no bytecode is generated.
However, some packages do provide executables with extensions, and thus bytecode is generated.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | true
|
pip.overrides.<name>.deps¶
All dependencies of the package. This option should be set by the "outer world" and can be used to inherit attributes from pkgs or inputs etc.
By separating the task of retrieving things from the outside world, it is ensured that the dependencies are overridable.
Nothing will stop users from adding nixpkgs itself as a dependency, but this will make it very hard for the user of the package to override any dependencies, because they'd have to figure out a way to insert their changes into the Nixpkgs fixpoint. By adding specific attributes to deps instead, the user has a realistic chance of overriding those dependencies.
So deps should be specific, but not overly specific. For instance, the caller shouldn't have to know the version of a dependency in order to override it. The name should suffice. (e.g. nix = nixVersions.nix_2_12 instead of inherit (nixVersions) nix_2_12.
| type | lazy attribute set of raw value |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix, dream2nix/modules/dream2nix/core/deps, dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | { }
|
| example |
{nixpkgs, ...}: {
inherit (nixpkgs) stdenv;
inherit (nixpkgs.haskellPackages) pandoc;
}
|
# pip.overrides.<name>.deps.python¶
The python interpreter package to use
| type | package |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
# pip.overrides.<name>.deps.stdenv¶
The stdenv used for building this package
| type | raw value |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
pip.overrides.<name>.env¶
environment variables passed to the build environment
| type | attribute set of (null or boolean or signed integer or string or path or package or list of (boolean or signed integer or string or path or package)) |
| source | dream2nix/modules/dream2nix/core/env |
| default | { }
|
mkDerivation¶
# pip.overrides.<name>.mkDerivation.__contentAddressed¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.__darwinAllowLocalNetworking¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.__impureHostDeps¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.__propagatedImpureHostDeps¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.__structuredAttrs¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.allowSubstitutes¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.allowedReferences¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.allowedRequisites¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.args¶
| type | null or (list of (string or path)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.buildFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.buildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.buildPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.builder¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.checkFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.checkInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.checkPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.checkTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.cmakeFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.configureFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.configurePhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.configurePlatforms¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.configureScript¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsBuildBuild¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsBuildBuildPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsBuildTarget¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsBuildTargetPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsHostHost¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsHostHostPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsTargetTarget¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.depsTargetTargetPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.disallowedReferences¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.disallowedRequisites¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.distFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.distPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.distTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.doCheck¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.doDist¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.doInstallCheck¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontAddDisableDepTrack¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontAddPrefix¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontAddStaticConfigureFlags¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontBuild¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontConfigure¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontCopyDist¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontDisableStatic¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontFixLibtool¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontFixup¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontInstall¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontMakeSourcesWritable¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontMoveBin¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontPatch¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontPatchELF¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontPatchShebangs¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontPruneLibtoolFiles¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontStrip¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontStripHost¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontStripTarget¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.dontUnpack¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.enableParallelBuilding¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.enableParallelChecking¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.exportReferenceGraph¶
| type | null or (list of (string or package)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.fixupPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.forceShare¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.hardeningDisable¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.hardeningEnable¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.impureEnvVars¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.installCheckFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.installCheckInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.installCheckPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.installCheckTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.installFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.installPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.installTargets¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.makeFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.makefile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.mesonFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.meta¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
# pip.overrides.<name>.mkDerivation.nativeBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.nativeCheckInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.outputHash¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.outputHashAlgo¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.outputHashMode¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.outputs¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | [
"out"
]
|
# pip.overrides.<name>.mkDerivation.passAsFile¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.passthru¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
# pip.overrides.<name>.mkDerivation.patchFlags¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.patchPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.patches¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.phases¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.pos¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
# pip.overrides.<name>.mkDerivation.postBuild¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postConfigure¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postDist¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postFixup¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postInstalCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postInstall¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postPatch¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.postUnpack¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preBuild¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preBuildPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preConfigure¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preConfigurePhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preDist¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preDistPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preFixup¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preFixupPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preInstall¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preInstallCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preInstallPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.prePatch¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.prePhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preUnpack¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.preferLocalBuild¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.prefix¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.prefixKey¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.propagatedBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.propagatedNativeBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.propagatedSandboxProfile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.realBuilder¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.requiredSystemFeatures¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.sandboxProfile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.separateDebugInfo¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.setSourceRoot¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.setupHook¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.shellHook¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.sourceRoot¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.src¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.srcs¶
| type | null or (list of (string or path or package)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.strictDeps¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.stripAllFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.stripAllList¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.stripDebugFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.stripDebugList¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.tarballs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.unpackCmd¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.unpackPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
# pip.overrides.<name>.mkDerivation.version¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
pip.overrides.<name>.name¶
The name of the package
| type | string |
| source | dream2nix/modules/dream2nix/core/ui/interface.nix |
pip.overrides.<name>.public¶
The final result of the evaluated package.
Contains everything that nix expects from a derivation.
Contains fields like name, outputs, drvPath, outPath, etc.
Can be build with nix-build or nix build.
| type | lazy attribute set of anything |
| source | dream2nix/modules/dream2nix/core/public/interface.nix |
pip.overrides.<name>.version¶
The version of the package
| type | string |
| source | dream2nix/modules/dream2nix/core/ui/interface.nix |
pip.pipFlags¶
list of flags for pip install
| type | list of string |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | [ ]
|
pip.pipVersion¶
pip version to use to generate the report
| type | string |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | "23.1"
|
pip.pypiSnapshotDate¶
maximum release date for packages Choose any date from the past.
| type | null or string |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | null
|
| example |
"2023-01-01"
|
pip.requirementsFiles¶
list of requirements.txt files
| type | list of string |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | [ ]
|
pip.requirementsList¶
list of strings of requirements.txt entries
| type | list of string |
| source | dream2nix/modules/dream2nix/pip/interface.nix |
| default | [ ]
|
env¶
environment variables passed to the build environment
| type | attribute set of (null or boolean or signed integer or string or path or package or list of (boolean or signed integer or string or path or package)) |
| source | dream2nix/modules/dream2nix/core/env |
| default | { }
|
name¶
The name of the package
| type | string |
| source | dream2nix/modules/dream2nix/core/ui/interface.nix |
version¶
The version of the package
| type | string |
| source | dream2nix/modules/dream2nix/core/ui/interface.nix |
buildPythonPackage¶
buildPythonPackage.build-system¶
Build-time only Python dependencies. Items listed in build-system.requires/setup_requires.
| type | list of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.catchConflicts¶
Raise an error if two packages are installed with the same name TODO: For cross we probably need a different PYTHONPATH, or not add the runtime deps until after buildPhase.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | ''
true if the host and build platforms are the same, false otherwise.
''
|
buildPythonPackage.dependencies¶
List of runtime python dependencies. Aside from propagating dependencies,
buildPythonPackage also injects code into and wraps executables with the
paths included in this list. Items listed in install_requires go here.
| type | list of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.disabled¶
used to disable derivation, useful for specific python versions
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
buildPythonPackage.disabledTestPaths¶
Test paths to ignore in checkPhase
| type | list of anything |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.disabledTests¶
Disable running specific unit tests
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.dontUsePipInstall¶
Don't use Pip to install a wheel Note this is actually a variable for the pipInstallPhase in pip's setupHook. It's included here to prevent an infinite recursion.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
buildPythonPackage.dontWrapPythonPrograms¶
Skip wrapping of python programs altogether
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
buildPythonPackage.format¶
Several package formats are supported:
null: Disable this legacy option and use the new pyproject option instead.
"setuptools" : Install a common setuptools/distutils based package. This builds a wheel.
"wheel" : Install from a pre-compiled wheel.
"flit" : Install a flit package. This builds a wheel.
"pyproject": Install a package using a pyproject.toml file (PEP517). This builds a wheel.
"egg": Install a package from an egg.
"other" : Provide your own buildPhase and installPhase.
| type | null or string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | "setuptools"
|
buildPythonPackage.makeWrapperArgs¶
Additional arguments to pass to the makeWrapper function, which wraps generated binaries.
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.optional-dependencies¶
Optional feature flagged dependencies. Items listed in extras_requires go here.
| type | attribute set of (string or path or package) |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | { }
|
buildPythonPackage.permitUserSite¶
Skip setting the PYTHONNOUSERSITE environment variable in wrapped programs
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | false
|
buildPythonPackage.pipInstallFlags¶
Extra flags passed to pip install
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.pyproject¶
Whether the pyproject format should be used. When set to true,
pypaBuildHook will be used, and you can add the required build dependencies
from build-system.requires to build-system.
Note that the pyproject format falls back to using setuptools, so
you can use pyproject = true even if the package only has a setup.py.
When set to false, you can use the existing hooks or provide your own
logic to build the package. This can be useful for packages that don't
support the pyproject format.
When unset, the legacy setuptools hooks are used for backwards compatibility.
| type | null or boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | null
|
buildPythonPackage.pytestFlagsArray¶
Extra flags passed to pytest
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.pythonImportsCheck¶
Check whether importing the listed modules works
| type | list of string |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | [ ]
|
buildPythonPackage.removeBinBytecode¶
Remove bytecode from bin folder.
When a Python script has the extension .py, bytecode is generated
Typically, executables in bin have no extension, so no bytecode is generated.
However, some packages do provide executables with extensions, and thus bytecode is generated.
| type | boolean |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
| default | true
|
deps¶
All dependencies of the package. This option should be set by the "outer world" and can be used to inherit attributes from pkgs or inputs etc.
By separating the task of retrieving things from the outside world, it is ensured that the dependencies are overridable.
Nothing will stop users from adding nixpkgs itself as a dependency, but this will make it very hard for the user of the package to override any dependencies, because they'd have to figure out a way to insert their changes into the Nixpkgs fixpoint. By adding specific attributes to deps instead, the user has a realistic chance of overriding those dependencies.
So deps should be specific, but not overly specific. For instance, the caller shouldn't have to know the version of a dependency in order to override it. The name should suffice. (e.g. nix = nixVersions.nix_2_12 instead of inherit (nixVersions) nix_2_12.
| type | lazy attribute set of raw value |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix, dream2nix/modules/dream2nix/core/deps, dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
| example |
{nixpkgs, ...}: {
inherit (nixpkgs) stdenv;
inherit (nixpkgs.haskellPackages) pandoc;
}
|
deps.python¶
The python interpreter package to use
| type | package |
| source | dream2nix/modules/dream2nix/buildPythonPackage/interface.nix |
deps.stdenv¶
The stdenv used for building this package
| type | raw value |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
lock¶
lock.content¶
The content of the lock file.
All fields declared via lock.fields are contained pointing to their respective values.
| type | anything |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
lock.extraScripts¶
Extra shell scripts to execute when nix run .#{package}.lock is called.
This allows adding custom logic to the lock file generation.
| type | list of path |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
| default | [ ]
|
lock.fields¶
Fields of the lock file
| type | attribute set of (submodule) |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
| default | { }
|
| example |
{
pname = true;
version = true;
}
|
<name>¶
lock.fields.<name>.default¶
The default value in case the lock file doesn't exist or doesn't yet contain the field.
| type | null or anything |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
| default | null
|
lock.fields.<name>.script¶
A script to refresh the value of this lock file field. The script should write the result as json file to $out.
| type | path |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
lock.invalidationData¶
Pass any data that should invalidate the lock file when changed. This is useful for example when the lock file should be regenerated when the requirements change.
| type | anything |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
| default | { }
|
| example |
{
pip = {
lockVersion = "2";
requirements = [
"requests"
"pillow"
];
};
}
|
lib¶
lock.lib.computeFODHash¶
Helper function to write the hash of a given FOD to $out.
| type | function that evaluates to a(n) path (read only) |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
lock.refresh¶
Script to refresh the lock file
| type | package (read only) |
| source | dream2nix/modules/dream2nix/core/lock/interface.nix |
mkDerivation¶
mkDerivation.__contentAddressed¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.__darwinAllowLocalNetworking¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.__impureHostDeps¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.__propagatedImpureHostDeps¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.__structuredAttrs¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.allowSubstitutes¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.allowedReferences¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.allowedRequisites¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.args¶
| type | null or (list of (string or path)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.buildFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.buildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.buildPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.builder¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.checkFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.checkInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.checkPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.checkTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.cmakeFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.configureFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.configurePhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.configurePlatforms¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.configureScript¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsBuildBuild¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsBuildBuildPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsBuildTarget¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsBuildTargetPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsHostHost¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsHostHostPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsTargetTarget¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.depsTargetTargetPropagated¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.disallowedReferences¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.disallowedRequisites¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.distFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.distPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.distTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.doCheck¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.doDist¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.doInstallCheck¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontAddDisableDepTrack¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontAddPrefix¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontAddStaticConfigureFlags¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontBuild¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontConfigure¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontCopyDist¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontDisableStatic¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontFixLibtool¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontFixup¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontInstall¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontMakeSourcesWritable¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontMoveBin¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontPatch¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontPatchELF¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontPatchShebangs¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontPruneLibtoolFiles¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontStrip¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontStripHost¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontStripTarget¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.dontUnpack¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.enableParallelBuilding¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.enableParallelChecking¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.exportReferenceGraph¶
| type | null or (list of (string or package)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.fixupPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.forceShare¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.hardeningDisable¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.hardeningEnable¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.impureEnvVars¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.installCheckFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.installCheckInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.installCheckPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.installCheckTarget¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.installFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.installPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.installTargets¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.makeFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.makefile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.mesonFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.meta¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
mkDerivation.nativeBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.nativeCheckInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.outputHash¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.outputHashAlgo¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.outputHashMode¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.outputs¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | [
"out"
]
|
mkDerivation.passAsFile¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.passthru¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
mkDerivation.patchFlags¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.patchPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.patches¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.phases¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.pos¶
| type | null or (attribute set) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | { }
|
mkDerivation.postBuild¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postConfigure¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postDist¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postFixup¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postInstalCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postInstall¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postPatch¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.postUnpack¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preBuild¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preBuildPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preConfigure¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preConfigurePhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preDist¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preDistPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preFixup¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preFixupPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preInstall¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preInstallCheck¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preInstallPhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.prePatch¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.prePhases¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preUnpack¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.preferLocalBuild¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.prefix¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.prefixKey¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.propagatedBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.propagatedNativeBuildInputs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.propagatedSandboxProfile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.realBuilder¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.requiredSystemFeatures¶
| type | null or (list of string) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.sandboxProfile¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.separateDebugInfo¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.setSourceRoot¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.setupHook¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.shellHook¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.sourceRoot¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.src¶
| type | null or string or path or package or (submodule) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.srcs¶
| type | null or (list of (string or path or package)) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.strictDeps¶
| type | null or boolean |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.stripAllFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.stripAllList¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.stripDebugFlags¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.stripDebugList¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.tarballs¶
| type | null or (list of anything) |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.unpackCmd¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.unpackPhase¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
mkDerivation.version¶
| type | null or string |
| source | dream2nix/modules/dream2nix/mkDerivation/interface.nix |
| default | null
|
paths¶
paths.cacheFile¶
Path to the eval cache file of the current package. Relative to "${paths.projectRoot}/${paths.package}"".
| type | string |
| source | dream2nix/modules/dream2nix/core/paths/interface.nix |
| default | "cache.json"
|
paths.lockFile¶
Path to the lock file of the current package. Relative to "${paths.projectRoot}/${paths.package}"".
| type | string |
| source | dream2nix/modules/dream2nix/core/paths/interface.nix |
| default | "lock.json"
|
paths.package¶
Path to the directory containing the definition of the current package. Relative to 'paths.projectRoot'.
This helps locating package definitions for lock & update scripts.
| type | path or string |
| source | dream2nix/modules/dream2nix/core/paths/interface.nix |
paths.projectRoot¶
Path to the root of the project on which dream2nix operates. Must contain the marker file specified by 'paths.projectRootFile'
This helps locating lock files at evaluation time.
| type | path |
| source | dream2nix/modules/dream2nix/core/paths/interface.nix |
| example |
./.
|
paths.projectRootFile¶
File name to look for to determine the root of the project. Ensure 'paths.projectRoot' contains a file named like this.
This helps locating package definitions for lock & update scripts.
| type | string |
| source | dream2nix/modules/dream2nix/core/paths/interface.nix |
| default | ".git"
|
| example |
".git"
|
public¶
The final result of the evaluated package.
Contains everything that nix expects from a derivation.
Contains fields like name, outputs, drvPath, outPath, etc.
Can be build with nix-build or nix build.
| type | lazy attribute set of anything |
| source | dream2nix/modules/dream2nix/core/public/interface.nix, dream2nix/modules/dream2nix/core/docs |
public.docs¶
The manual of the package as a website
| type | package (read only) |
| source | dream2nix/modules/dream2nix/core/docs |