Skip to content

Commit

Permalink
doc/python: add section about replaced/stubbed/avoided packages
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperSandro2000 committed Aug 23, 2024
1 parent 9242a66 commit 814681b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/languages-frameworks/python.section.md
Original file line number Diff line number Diff line change
Expand Up @@ -2021,9 +2021,22 @@ The following rules are desired to be respected:
and using a `-` as delimiter.
* Attribute names in `python-packages.nix` should be sorted alphanumerically to
avoid merge conflicts and ease locating attributes.
* The list of [dependencies to avoid or replace](#python-dependencies-avoid-replace) is respected.

This list is useful for reviewers as well as for self-checking when submitting packages.

## Dependencies to avoid or replace {#python-dependencies-avoid-replace}

Some dependencies do not make sense inside a nix build and should be completely avoided or replaced by a stub.
Below you find a listing of the most common ones.

| Package | Replacement | Reason |
|---------|-------------|--------|
| cmake | cmake (stub) | The package normally downloads cmake from the internet. The stub provides our cmake with the usual setup hook. |
| ninja | ninja (stub) | The package normally downloads ninja from the internet. The stub provides our cmake with the usual setup hook. |
| pytest-cov | pytest-cov-stub | coverage is only useful for developers. |
| pytest-runner | | Dependencies cannot be downloaded and should be provided through nativeCheckInputs. |

## Package set maintenance {#python-package-set-maintenance}

The whole Python package set has a lot of packages that do not see regular
Expand Down

0 comments on commit 814681b

Please sign in to comment.