nixpkgs/pkgs/development/python-modules/arelle/default.nix
stuebinm ff1a94e523 treewide: add meta.mainProgram to packages with a single binary
The nixpkgs-unstable channel's programs.sqlite was used to identify
packages producing exactly one binary, and these automatically added
to their package definitions wherever possible.
2024-03-19 03:14:51 +01:00

74 lines
1.8 KiB
Nix

{ gui ? true,
buildPythonPackage, fetchFromGitHub, lib,
sphinx, lxml, isodate, numpy, openpyxl,
tkinter ? null, py3to2, isPy3k, python,
... }:
buildPythonPackage rec {
pname = "arelle${lib.optionalString (!gui) "-headless"}";
version = "18.3";
format = "setuptools";
disabled = !isPy3k;
# Releases are published at http://arelle.org/download/ but sadly no
# tags are published on github.
src = fetchFromGitHub {
owner = "Arelle";
repo = "Arelle";
rev = "edgr${version}";
sha256 = "12a94ipdp6xalqyds7rcp6cjwps6fbj3byigzfy403hlqc9n1g33";
};
outputs = ["out" "doc"];
patches = [
./tests.patch
];
postPatch = "rm testParser2.py";
nativeBuildInputs = [
sphinx
py3to2
];
propagatedBuildInputs = [
lxml
isodate
numpy
openpyxl
] ++ lib.optionals gui [
tkinter
];
# arelle-gui is useless without gui dependencies, so delete it when !gui.
postInstall = lib.optionalString (!gui) ''
find $out/bin -name "*arelle-gui*" -delete
'' +
# By default, not the entirety of the src dir is copied. This means we don't
# copy the `images` dir, which is needed for the gui version.
lib.optionalString (gui) ''
targetDir=$out/${python.sitePackages}
cp -vr $src/arelle $targetDir
'';
# Documentation
postBuild = ''
(cd apidocs && make html && cp -r _build $doc)
'';
doCheck = false;
checkPhase = ''
py.test
'';
meta = with lib; {
description = ''
An open source facility for XBRL, the eXtensible Business Reporting
Language supporting various standards, exposed through a Python or
REST API'' + lib.optionalString gui " and a graphical user interface";
mainProgram = "arelle";
homepage = "http://arelle.org/";
license = licenses.asl20;
platforms = platforms.all;
maintainers = with maintainers; [ roberth ];
};
}