pkgs/servers/matrix-synapse/tools/synadm.nix

   1 { lib
   2 , python3
   3 , fetchPypi
   4 , nix-update-script
   5 }:
   6
   7 python3.pkgs.buildPythonApplication rec {
   8   pname = "synadm";
   9   version = "0.46.1";
  10   format = "setuptools";
  11
  12   src = fetchPypi {
  13     inherit pname version;
  14     hash = "sha256-EjV3zTd6VAemNS/mD19Caw9SQZW1qs4+07wRxfVq++g=";
  15   };
  16
  17   propagatedBuildInputs = with python3.pkgs; [
  18     click
  19     click-option-group
  20     dnspython
  21     tabulate
  22     pyyaml
  23     requests
  24   ];
  25
  26   checkPhase = ''
  27     runHook preCheck
  28     export HOME=$TMPDIR
  29     $out/bin/synadm -h > /dev/null
  30     runHook postCheck
  31   '';
  32
  33   passthru.updateScript = nix-update-script { };
  34
  35   meta = with lib; {
  36     description = "Command line admin tool for Synapse";
  37     mainProgram = "synadm";
  38     longDescription = ''
  39       A CLI tool to help admins of Matrix Synapse homeservers
  40       conveniently issue commands available via its admin API's
  41       (element-hq/synapse@master/docs/admin_api)
  42     '';
  43     changelog = "https://github.com/JOJ0/synadm/releases/tag/v${version}";
  44     homepage = "https://github.com/JOJ0/synadm";
  45     license = licenses.gpl3Plus;
  46     maintainers = with maintainers; [ hexa ];
  47   };
  48 }