nixpkgs/pkgs/applications/office/paperless-ngx/default.nix
2023-11-30 17:46:25 +01:00

304 lines
6.2 KiB
Nix

{ lib
, stdenv
, fetchFromGitHub
, fetchpatch
, buildNpmPackage
, nixosTests
, gettext
, python3
, ghostscript
, imagemagickBig
, jbig2enc
, optipng
, pngquant
, qpdf
, tesseract5
, unpaper
, poppler_utils
, liberation_ttf
, xcbuild
}:
let
version = "2.0.1";
src = fetchFromGitHub {
owner = "paperless-ngx";
repo = "paperless-ngx";
rev = "refs/tags/v${version}";
hash = "sha256-qSX+r99y7a/eITfaC/UYqSgcxx/xYOqJ4tY/iuvoeNA=";
};
python = python3;
path = lib.makeBinPath [
ghostscript
imagemagickBig
jbig2enc
optipng
pngquant
qpdf
tesseract5
unpaper
poppler_utils
];
frontend = buildNpmPackage {
pname = "paperless-ngx-frontend";
inherit version src;
npmDepsHash = "sha256-uDaZ7j7IDgKy7wCWND2xzR1qHwUtdyjR4eyIAVy01dM=";
nativeBuildInputs = [
python3
] ++ lib.optionals stdenv.isDarwin [
xcbuild
];
postPatch = ''
cd src-ui
'';
CYPRESS_INSTALL_BINARY = "0";
NG_CLI_ANALYTICS = "false";
npmBuildFlags = [
"--" "--configuration" "production"
];
doCheck = true;
checkPhase = ''
runHook preCheck
npm run test
runHook postCheck
'';
installPhase = ''
runHook preInstall
mkdir -p $out/lib/paperless-ui
mv ../src/documents/static/frontend $out/lib/paperless-ui/
runHook postInstall
'';
};
in
python.pkgs.buildPythonApplication rec {
pname = "paperless-ngx";
format = "other";
inherit version src;
nativeBuildInputs = [
gettext
];
propagatedBuildInputs = with python.pkgs; [
amqp
anyio
asgiref
async-timeout
attrs
autobahn
automat
billiard
bleach
celery
certifi
cffi
channels-redis
channels
charset-normalizer
click
click-didyoumean
click-plugins
click-repl
coloredlogs
concurrent-log-handler
constantly
cryptography
dateparser
django-auditlog
django-celery-results
django-compression-middleware
django-cors-headers
django-extensions
django-filter
django-guardian
django-multiselectfield
django
djangorestframework-guardian2
djangorestframework
drf-writable-nested
filelock
flower
gotenberg-client
gunicorn
h11
h2
hiredis
httptools
httpx
humanfriendly
humanize
hyperlink
idna
imap-tools
img2pdf
incremental
inotify-simple
inotifyrecursive
joblib
langdetect
lxml
msgpack
mysqlclient
nltk
ocrmypdf
packaging
pathvalidate
pdf2image
pikepdf
pillow
pluggy
portalocker
prompt-toolkit
psycopg2
pyasn1-modules
pyasn1
pycparser
pyopenssl
python-dateutil
python-dotenv
python-ipware
python-magic
python-gnupg
pytz
pyyaml
pyzbar
rapidfuzz
redis
regex
reportlab
requests
scikit-learn
scipy
setproctitle
service-identity
sniffio
sqlparse
threadpoolctl
tika-client
tornado
tqdm
twisted
txaio
tzdata
tzlocal
urllib3
uvicorn
uvloop
vine
watchdog
watchfiles
wcwidth
webencodings
websockets
whitenoise
whoosh
zipp
zope_interface
zxing-cpp
]
++ redis.optional-dependencies.hiredis
++ twisted.optional-dependencies.tls
++ uvicorn.optional-dependencies.standard;
postBuild = ''
# Compile manually because `pythonRecompileBytecodeHook` only works
# for files in `python.sitePackages`
${python.pythonOnBuildForHost.interpreter} -OO -m compileall src
# Collect static files
${python.pythonOnBuildForHost.interpreter} src/manage.py collectstatic --clear --no-input
# Compile string translations using gettext
${python.pythonOnBuildForHost.interpreter} src/manage.py compilemessages
'';
installPhase = ''
mkdir -p $out/lib/paperless-ngx
cp -r {src,static,LICENSE,gunicorn.conf.py} $out/lib/paperless-ngx
ln -s ${frontend}/lib/paperless-ui/frontend $out/lib/paperless-ngx/static/
chmod +x $out/lib/paperless-ngx/src/manage.py
makeWrapper $out/lib/paperless-ngx/src/manage.py $out/bin/paperless-ngx \
--prefix PYTHONPATH : "$PYTHONPATH" \
--prefix PATH : "${path}"
makeWrapper ${python.pkgs.celery}/bin/celery $out/bin/celery \
--prefix PYTHONPATH : "$PYTHONPATH:$out/lib/paperless-ngx/src" \
--prefix PATH : "${path}"
'';
postFixup = ''
# Remove tests with samples (~14M)
find $out/lib/paperless-ngx -type d -name tests -exec rm -rv {} +
'';
nativeCheckInputs = with python.pkgs; [
daphne
factory-boy
imagehash
pytest-django
pytest-env
pytest-httpx
pytest-rerunfailures
pytest-xdist
pytestCheckHook
reportlab
];
pytestFlagsArray = [
"src"
];
# The tests require:
# - PATH with runtime binaries
# - A temporary HOME directory for gnupg
# - XDG_DATA_DIRS with test-specific fonts
preCheck = ''
export PATH="${path}:$PATH"
export HOME=$(mktemp -d)
export XDG_DATA_DIRS="${liberation_ttf}/share:$XDG_DATA_DIRS"
# Disable unneeded code coverage test
substituteInPlace src/setup.cfg \
--replace "--cov --cov-report=html --cov-report=xml" ""
# OCR on NixOS recognizes the space in the picture, upstream CI doesn't.
# See https://github.com/paperless-ngx/paperless-ngx/pull/2216
substituteInPlace src/paperless_tesseract/tests/test_parser.py \
--replace "this is awebp document" "this is a webp document"
'';
disabledTests = [
# FileNotFoundError(2, 'No such file or directory'): /build/tmp...
"test_script_with_output"
# AssertionError: 10 != 4 (timezone/time issue)
# Due to getting local time from modification date in test_consumer.py
"testNormalOperation"
];
doCheck = !stdenv.isDarwin;
passthru = {
inherit python path frontend;
tests = { inherit (nixosTests) paperless; };
};
meta = with lib; {
description = "Tool to scan, index, and archive all of your physical documents";
homepage = "https://docs.paperless-ngx.com/";
changelog = "https://github.com/paperless-ngx/paperless-ngx/releases/tag/v${version}";
license = licenses.gpl3Only;
platforms = platforms.unix;
maintainers = with maintainers; [ lukegb gador erikarvstedt leona ];
};
}