Skip to content

python-pdm

state: experimental
maintainers: @DavHau

Introduction

Options

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
null

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.pythonRelaxDeps

List of dependency names on which to remove version constraints. Or the boolean value true to remove all of them

type (list of string) or boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

buildPythonPackage.pythonRemoveDeps

List of dependency names which to remove.

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/mkDerivation/interface.nix, dream2nix/modules/dream2nix/buildPythonPackage/interface.nix, dream2nix/modules/dream2nix/core/deps
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

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
{ }

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;
}

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"
    ];
  };
}

lock.isValid

Check whether the current lock file is valid, which means we don't need to lock again.

type boolean (read only)
source dream2nix/modules/dream2nix/core/lock/interface.nix

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.__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

name

The name of the package

type string
source dream2nix/modules/dream2nix/core/ui/interface.nix

overrideAll

Overrides applied on all dependencies.

type module
source dream2nix/modules/dream2nix/overrides/interface.nix
default
{ }
example
{
  mkDerivation = {
    doCheck = false;
  };
}

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
[ ]

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.
''

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
[ ]

overrideAll.buildPythonPackage.disabled

used to disable derivation, useful for specific python versions

type boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
false

overrideAll.buildPythonPackage.disabledTestPaths

Test paths to ignore in checkPhase

type list of anything
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrideAll.buildPythonPackage.disabledTests

Disable running specific unit tests

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

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

overrideAll.buildPythonPackage.dontWrapPythonPrograms

Skip wrapping of python programs altogether

type boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
false

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"

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
[ ]

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
{ }

overrideAll.buildPythonPackage.permitUserSite

Skip setting the PYTHONNOUSERSITE environment variable in wrapped programs

type boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
false

overrideAll.buildPythonPackage.pipInstallFlags

Extra flags passed to pip install

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

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

overrideAll.buildPythonPackage.pytestFlagsArray

Extra flags passed to pytest

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrideAll.buildPythonPackage.pythonImportsCheck

Check whether importing the listed modules works

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrideAll.buildPythonPackage.pythonRelaxDeps

List of dependency names on which to remove version constraints. Or the boolean value true to remove all of them

type (list of string) or boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrideAll.buildPythonPackage.pythonRemoveDeps

List of dependency names which to remove.

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

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

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;
}

overrideAll.deps.python

The python interpreter package to use

type package
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix

overrideAll.deps.stdenv

The stdenv used for building this package

type raw value
source dream2nix/modules/dream2nix/mkDerivation/interface.nix

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
{ }

overrideAll.mkDerivation.__contentAddressed

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.__darwinAllowLocalNetworking

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.__impureHostDeps

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.__propagatedImpureHostDeps

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.__structuredAttrs

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.allowSubstitutes

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.allowedReferences

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.allowedRequisites

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.args

type null or (list of (string or path))
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.buildFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.buildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.buildPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.builder

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.checkFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.checkInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.checkPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.checkTarget

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.cmakeFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.configureFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.configurePhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.configurePlatforms

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.configureScript

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsBuildBuild

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsBuildBuildPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsBuildTarget

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsBuildTargetPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsHostHost

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsHostHostPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsTargetTarget

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.depsTargetTargetPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.disallowedReferences

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.disallowedRequisites

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.distFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.distPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.distTarget

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.doCheck

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.doDist

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.doInstallCheck

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontAddDisableDepTrack

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontAddPrefix

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontAddStaticConfigureFlags

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontBuild

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontConfigure

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontCopyDist

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontDisableStatic

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontFixLibtool

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontFixup

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontInstall

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontMakeSourcesWritable

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontMoveBin

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontPatch

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontPatchELF

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontPatchShebangs

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontPruneLibtoolFiles

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontStrip

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontStripHost

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontStripTarget

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.dontUnpack

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.enableParallelBuilding

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.enableParallelChecking

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.exportReferenceGraph

type null or (list of (string or package))
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.fixupPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.forceShare

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.hardeningDisable

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.hardeningEnable

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.impureEnvVars

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.installCheckFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.installCheckInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.installCheckPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.installCheckTarget

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.installFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.installPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.installTargets

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.makeFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.makefile

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.mesonFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.meta

type null or (attribute set)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
{ }

overrideAll.mkDerivation.nativeBuildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.nativeCheckInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.outputHash

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.outputHashAlgo

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.outputHashMode

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.outputs

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
[
  "out"
]

overrideAll.mkDerivation.passAsFile

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.passthru

type null or (attribute set)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
{ }

overrideAll.mkDerivation.patchFlags

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.patchPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.patches

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.phases

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.pos

type null or (attribute set)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
{ }

overrideAll.mkDerivation.postBuild

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postConfigure

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postDist

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postFixup

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postInstalCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postInstall

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postPatch

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.postUnpack

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preBuild

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preBuildPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preConfigure

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preConfigurePhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preDist

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preDistPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preFixup

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preFixupPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preInstall

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preInstallCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preInstallPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.prePatch

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.prePhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preUnpack

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.preferLocalBuild

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.prefix

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.prefixKey

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.propagatedBuildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.propagatedNativeBuildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.propagatedSandboxProfile

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.realBuilder

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.requiredSystemFeatures

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.sandboxProfile

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.separateDebugInfo

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.setSourceRoot

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.setupHook

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.shellHook

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.sourceRoot

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.src

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.srcs

type null or (list of (string or path or package))
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.strictDeps

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.stripAllFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.stripAllList

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.stripDebugFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.stripDebugList

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.tarballs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.unpackCmd

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.unpackPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.mkDerivation.version

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrideAll.name

The name of the package

type string
source dream2nix/modules/dream2nix/core/ui/interface.nix

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

overrideAll.version

The version of the package

type string
source dream2nix/modules/dream2nix/core/ui/interface.nix

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
      '';
    };
  };
}

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
[ ]

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.
''

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
[ ]

overrides.<name>.buildPythonPackage.disabled

used to disable derivation, useful for specific python versions

type boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
false

overrides.<name>.buildPythonPackage.disabledTestPaths

Test paths to ignore in checkPhase

type list of anything
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrides.<name>.buildPythonPackage.disabledTests

Disable running specific unit tests

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

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

overrides.<name>.buildPythonPackage.dontWrapPythonPrograms

Skip wrapping of python programs altogether

type boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
false

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"

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
[ ]

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
{ }

overrides.<name>.buildPythonPackage.permitUserSite

Skip setting the PYTHONNOUSERSITE environment variable in wrapped programs

type boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
false

overrides.<name>.buildPythonPackage.pipInstallFlags

Extra flags passed to pip install

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

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

overrides.<name>.buildPythonPackage.pytestFlagsArray

Extra flags passed to pytest

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrides.<name>.buildPythonPackage.pythonImportsCheck

Check whether importing the listed modules works

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrides.<name>.buildPythonPackage.pythonRelaxDeps

List of dependency names on which to remove version constraints. Or the boolean value true to remove all of them

type (list of string) or boolean
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

overrides.<name>.buildPythonPackage.pythonRemoveDeps

List of dependency names which to remove.

type list of string
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix
default
[ ]

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

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;
}

overrides.<name>.deps.python

The python interpreter package to use

type package
source dream2nix/modules/dream2nix/buildPythonPackage/interface.nix

overrides.<name>.deps.stdenv

The stdenv used for building this package

type raw value
source dream2nix/modules/dream2nix/mkDerivation/interface.nix

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
{ }

overrides.<name>.mkDerivation.__contentAddressed

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.__darwinAllowLocalNetworking

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.__impureHostDeps

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.__propagatedImpureHostDeps

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.__structuredAttrs

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.allowSubstitutes

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.allowedReferences

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.allowedRequisites

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.args

type null or (list of (string or path))
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.buildFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.buildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.buildPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.builder

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.checkFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.checkInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.checkPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.checkTarget

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.cmakeFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.configureFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.configurePhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.configurePlatforms

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.configureScript

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsBuildBuild

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsBuildBuildPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsBuildTarget

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsBuildTargetPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsHostHost

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsHostHostPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsTargetTarget

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.depsTargetTargetPropagated

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.disallowedReferences

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.disallowedRequisites

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.distFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.distPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.distTarget

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.doCheck

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.doDist

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.doInstallCheck

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontAddDisableDepTrack

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontAddPrefix

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontAddStaticConfigureFlags

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontBuild

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontConfigure

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontCopyDist

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontDisableStatic

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontFixLibtool

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontFixup

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontInstall

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontMakeSourcesWritable

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontMoveBin

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontPatch

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontPatchELF

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontPatchShebangs

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontPruneLibtoolFiles

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontStrip

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontStripHost

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontStripTarget

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.dontUnpack

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.enableParallelBuilding

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.enableParallelChecking

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.exportReferenceGraph

type null or (list of (string or package))
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.fixupPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.forceShare

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.hardeningDisable

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.hardeningEnable

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.impureEnvVars

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.installCheckFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.installCheckInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.installCheckPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.installCheckTarget

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.installFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.installPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.installTargets

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.makeFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.makefile

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.mesonFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.meta

type null or (attribute set)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
{ }

overrides.<name>.mkDerivation.nativeBuildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.nativeCheckInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.outputHash

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.outputHashAlgo

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.outputHashMode

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.outputs

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
[
  "out"
]

overrides.<name>.mkDerivation.passAsFile

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.passthru

type null or (attribute set)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
{ }

overrides.<name>.mkDerivation.patchFlags

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.patchPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.patches

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.phases

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.pos

type null or (attribute set)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
{ }

overrides.<name>.mkDerivation.postBuild

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postConfigure

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postDist

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postFixup

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postInstalCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postInstall

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postPatch

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.postUnpack

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preBuild

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preBuildPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preConfigure

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preConfigurePhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preDist

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preDistPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preFixup

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preFixupPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preInstall

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preInstallCheck

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preInstallPhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.prePatch

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.prePhases

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preUnpack

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.preferLocalBuild

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.prefix

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.prefixKey

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.propagatedBuildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.propagatedNativeBuildInputs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.propagatedSandboxProfile

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.realBuilder

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.requiredSystemFeatures

type null or (list of string)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.sandboxProfile

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.separateDebugInfo

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.setSourceRoot

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.setupHook

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.shellHook

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.sourceRoot

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.src

type null or string or path or package or (submodule)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.srcs

type null or (list of (string or path or package))
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.strictDeps

type null or boolean
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.stripAllFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.stripAllList

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.stripDebugFlags

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.stripDebugList

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.tarballs

type null or (list of anything)
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.unpackCmd

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.unpackPhase

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.mkDerivation.version

type null or string
source dream2nix/modules/dream2nix/mkDerivation/interface.nix
default
null

overrides.<name>.name

The name of the package

type string
source dream2nix/modules/dream2nix/core/ui/interface.nix

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

overrides.<name>.version

The version of the package

type string
source dream2nix/modules/dream2nix/core/ui/interface.nix

pdm

type submodule
source dream2nix/modules/dream2nix/WIP-python-pdm/interface.nix

pdm.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;
}

pdm.editables

An attribute set mapping package names to a path, absolute or relative, of source directories which should be installed in editable mode in editablesShellHook. i.e.

  pip.editables.charset-normalizer = "/home/user/src/charset-normalizer".

The top-level package is included automatically.

This must be a string, as otherwise content would be copied to the nix store and loaded from there, voiding the benefits of editable installs. For the same reason, it is advised to use source filtering if you use a path inside the current repo to avoid unecessary rebuilds.

type attribute set of string
source dream2nix/modules/dream2nix/python-editables/interface.nix

pdm.editablesDevShell

type package (read only)
source dream2nix/modules/dream2nix/python-editables/interface.nix

pdm.editablesShellHook

A shellHook to be included into your devShells to install editables

type string (read only)
source dream2nix/modules/dream2nix/python-editables/interface.nix

pdm.lockfile

type path
source dream2nix/modules/dream2nix/WIP-python-pdm/interface.nix

pdm.overrideAll

Overrides applied on all dependencies.

type module
source dream2nix/modules/dream2nix/overrides/interface.nix
default
{ }
example
{
  mkDerivation = {
    doCheck = false;
  };
}

pdm.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
      '';
    };
  };
}

pdm.pyproject

type path
source dream2nix/modules/dream2nix/WIP-python-pdm/interface.nix

pdm.sourceSelector

A selector function which picks a source for a specific dependency Python dependencies can have multiple possible sources, like for example: - requests-2.31.0.tar.gz - requests-2.31.0-py3-none-any.whl The selector receives a list of possible sources and should return either a single source or null.

type one of "wheel", "sdist" or function that evaluates to a(n) string
source dream2nix/modules/dream2nix/WIP-python-pdm/interface.nix
example
fnames: lib.findFirst (fname: lib.hasSuffix "none-any.whl") none fnames

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

version

The version of the package

type string
source dream2nix/modules/dream2nix/core/ui/interface.nix