nixpkgs/pkgs/development/python-modules/pipx/default.nix
Ilya Grigoriev 56be20aa49 pipx: add shell completions
Install shell completions with `pipx` for `bash`, `zsh` and `fish`.

Apart from convenience, this reduces confusion. `pipx completions` is
not quite accurate when `pipx` is installed with Nix, since you need to
do  `nix shell nixpkgs#python311Packages.argcomplete
register-python-argcomplete`. It is possible to also put it in the path,
as suggested in
https://discourse.nixos.org/t/python-how-to-expose-a-dependencys-bin/283,
but that would be a separate PR.

Fixes https://github.com/NixOS/nixpkgs/issues/299845

Cc: [@natsukium](https://github.com/natsukium),
[@mweinelt](https://github.com/mweinelt),
[@yshym](https://github.com/yshym) (same people I Cc-ed in the issue)
2024-03-30 23:56:19 -07:00

103 lines
2.1 KiB
Nix

{ lib
, argcomplete
, buildPythonPackage
, fetchFromGitHub
, hatchling
, hatch-vcs
, installShellFiles
, packaging
, platformdirs
, pytestCheckHook
, pythonOlder
, tomli
, userpath
, git
}:
buildPythonPackage rec {
pname = "pipx";
version = "1.4.3";
pyproject = true;
disabled = pythonOlder "3.8";
src = fetchFromGitHub {
owner = "pypa";
repo = "pipx";
rev = "refs/tags/${version}";
hash = "sha256-NxXOeVXwBhGqi4DUABV8UV+cDER0ROBFdgiyYTzdvuo=";
};
build-system = [
hatchling
hatch-vcs
];
dependencies = [
argcomplete
packaging
platformdirs
userpath
] ++ lib.optionals (pythonOlder "3.11") [
tomli
];
nativeBuildInputs = [
installShellFiles
];
nativeCheckInputs = [
pytestCheckHook
git
];
preCheck = ''
export HOME=$(mktemp -d)
'';
pytestFlagsArray = [
"--ignore=tests/test_install_all_packages.py"
# start local pypi server and use in tests
"--net-pypiserver"
];
disabledTests = [
# disable tests which are difficult to emulate due to shell manipulations
"path_warning"
"script_from_internet"
"ensure_null_pythonpath"
# disable tests, which require internet connection
"install"
"inject"
"ensure_null_pythonpath"
"missing_interpreter"
"cache"
"internet"
"run"
"runpip"
"upgrade"
"suffix"
"legacy_venv"
"determination"
"json"
"test_list_short"
"test_skip_maintenance"
];
postInstall = ''
installShellCompletion --cmd pipx \
--bash <(${argcomplete}/bin/register-python-argcomplete pipx --shell bash) \
--zsh <(${argcomplete}/bin/register-python-argcomplete pipx --shell zsh) \
--fish <(${argcomplete}/bin/register-python-argcomplete pipx --shell fish)
'';
meta = with lib; {
description = "Install and run Python applications in isolated environments";
mainProgram = "pipx";
homepage = "https://github.com/pypa/pipx";
changelog = "https://github.com/pypa/pipx/blob/${version}/CHANGELOG.md";
license = licenses.mit;
maintainers = with maintainers; [ yshym ];
};
}