docs/integration/third_party/conda_deny.md
!!!tip "conda-deny in one command:"
In your favorite pixi workspace, run:
bash pixi exec conda-deny check --osi
This will check your workspace for license compliance against the list of [OSI approved licenses](https://opensource.org/licenses).
conda-deny is a CLI tool for checking software environment dependencies for license compliance. Compliance is checked with regard to an allowlist of licenses provided by the user.
You can install conda-deny using pixi:
pixi global install conda-deny
Or by downloading our pre-built binaries from the releases page.
conda-deny can be configured in your pixi.toml or pyproject.toml (pixi.toml is preferred).
The tool expects a configuration in the following format:
[tool.conda-deny]
#--------------------------------------------------------
# General setup options:
#--------------------------------------------------------
license-allowlist = "https://raw.githubusercontent.com/quantco/conda-deny/main/tests/test_remote_base_configs/conda-deny-license_allowlist.toml" # or ["license_allowlist.toml", "other_license_allowlist.toml"]
platform = "linux-64" # or ["linux-64", "osx-arm64"]
environment = "default" # or ["default", "py39", "py310", "prod"]
lockfile = "environment/pixi.lock" # or ["environment1/pixi.lock", "environment2/pixi.lock"]
# lockfile also supports glob patterns:
# lockfile = "environments/**/*.lock"
#--------------------------------------------------------
# License allowlist directly in configuration file:
#--------------------------------------------------------
safe-licenses = ["MIT", "BSD-3-Clause"]
ignore-packages = [
{ package = "make", version = "0.1.0" },
]
After the installation, you can run conda-deny check in your workspace.
This checks the dependencies defined by your pixi.lock against your allowlist.
If a Bearer Token is needed to access your allowlist, you can provide it using CONDA_DENY_BEARER_TOKEN.
An example use case would be a private repository containing your allowlist.
conda-deny supports different output formats via the --output (or -o) flag.
Output formatting works for both, the list and the check command.
=== "CSV"
bash $ conda-deny list --output csv package_name,version,license,platform,build,safe _openmp_mutex,4.5,BSD-3-Clause,linux-aarch64,2_gnu,false _openmp_mutex,4.5,BSD-3-Clause,linux-64,2_gnu,false ...
=== "JSON"
bash $ conda-deny list --output json-pretty { "unsafe": [ { "build": "conda_forge", "license": { "Invalid": "None" }, "package_name": "_libgcc_mutex", "platform": "linux-64", "version": "0.1" }, { "build": "h57d6b7b_14", "license": { "Invalid": "LGPL-2.0-or-later AND LGPL-2.0-or-later WITH exceptions AND GPL-2.0-or-later AND MPL-2.0" }, "package_name": "_sysroot_linux-aarch64_curr_repodata_hack", "platform": "noarch", "version": "4" }, ...
!!!tip Creating License Bundles
By running conda-deny bundle, conda-deny will create a directory containing all your dependencies' original license files.
This can come in handy when creating SBOMs or sharing compliance information with other people.