pkgs/by-name/tl/tldr/package.nix

   1 {
   2   stdenv,
   3   lib,
   4   fetchFromGitHub,
   5   installShellFiles,
   6   python3Packages,
   7 }:
   8
   9 python3Packages.buildPythonApplication rec {
  10   pname = "tldr";
  11   version = "3.3.0";
  12   pyproject = true;
  13
  14   src = fetchFromGitHub {
  15     owner = "tldr-pages";
  16     repo = "tldr-python-client";
  17     tag = version;
  18     hash = "sha256-lc0Jen8vW4BNg784td1AZa2GTYvXC1d83FnAe5RZqpY=";
  19   };
  20
  21   build-system = with python3Packages; [
  22     setuptools
  23     wheel
  24   ];
  25
  26   dependencies = with python3Packages; [
  27     termcolor
  28     colorama
  29     shtab
  30   ];
  31
  32   nativeBuildInputs = [ installShellFiles ];
  33
  34   nativeCheckInputs = with python3Packages; [
  35     pytest
  36   ];
  37
  38   checkPhase = ''
  39     runHook preCheck
  40     pytest -k 'not test_error_message'
  41     runHook postCheck
  42   '';
  43
  44   doCheck = true;
  45
  46   postInstall = lib.optionalString (stdenv.buildPlatform.canExecute stdenv.hostPlatform) ''
  47     installShellCompletion --cmd tldr \
  48       --bash <($out/bin/tldr --print-completion bash) \
  49       --zsh <($out/bin/tldr --print-completion zsh)
  50   '';
  51
  52   meta = {
  53     description = "Simplified and community-driven man pages";
  54     longDescription = ''
  55       tldr pages gives common use cases for commands, so you don't need to hunt
  56       through a man page for the correct flags.
  57     '';
  58     homepage = "https://tldr.sh";
  59     changelog = "https://github.com/tldr-pages/tldr-python-client/blob/${version}/CHANGELOG.md";
  60     license = lib.licenses.mit;
  61     maintainers = with lib.maintainers; [
  62       taeer
  63       carlosdagos
  64       kbdharun
  65     ];
  66     mainProgram = "tldr";
  67   };
  68 }