pkgs/development/python-modules/arelle/default.nix

   1 { gui ? true,
   2   buildPythonPackage, fetchFromGitHub, lib,
   3   sphinx, lxml, isodate, numpy, openpyxl,
   4   tkinter ? null, py3to2, isPy3k, python,
   5   ... }:
   6
   7 buildPythonPackage rec {
   8   pname = "arelle${lib.optionalString (!gui) "-headless"}";
   9   version = "18.3";
  10   format = "setuptools";
  11
  12   disabled = !isPy3k;
  13
  14   # Releases are published at http://arelle.org/download/ but sadly no
  15   # tags are published on github.
  16   src = fetchFromGitHub {
  17     owner = "Arelle";
  18     repo = "Arelle";
  19     rev = "edgr${version}";
  20     sha256 = "12a94ipdp6xalqyds7rcp6cjwps6fbj3byigzfy403hlqc9n1g33";
  21   };
  22   outputs = ["out" "doc"];
  23   patches = [
  24     ./tests.patch
  25   ];
  26   postPatch = "rm testParser2.py";
  27   nativeBuildInputs = [
  28     sphinx
  29     py3to2
  30   ];
  31   propagatedBuildInputs = [
  32     lxml
  33     isodate
  34     numpy
  35     openpyxl
  36   ] ++ lib.optionals gui [
  37     tkinter
  38   ];
  39
  40   # arelle-gui is useless without gui dependencies, so delete it when !gui.
  41   postInstall = lib.optionalString (!gui) ''
  42     find $out/bin -name "*arelle-gui*" -delete
  43   '' +
  44   # By default, not the entirety of the src dir is copied. This means we don't
  45   # copy the `images` dir, which is needed for the gui version.
  46   lib.optionalString (gui) ''
  47     targetDir=$out/${python.sitePackages}
  48     cp -vr $src/arelle $targetDir
  49   '';
  50
  51   # Documentation
  52   postBuild = ''
  53     (cd apidocs && make html && cp -r _build $doc)
  54     '';
  55
  56   doCheck = false;
  57
  58   checkPhase = ''
  59     py.test
  60   '';
  61
  62   meta = with lib; {
  63     description = ''
  64       An open source facility for XBRL, the eXtensible Business Reporting
  65       Language supporting various standards, exposed through a Python or
  66       REST API'' + lib.optionalString gui " and a graphical user interface";
  67     mainProgram = "arelle";
  68     homepage = "http://arelle.org/";
  69     license = licenses.asl20;
  70     platforms = platforms.all;
  71     maintainers = with maintainers; [ roberth ];
  72   };
  73 }