nixpkgs/pkgs/games/anki/default.nix
2021-08-03 10:45:48 +02:00

210 lines
5.7 KiB
Nix
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{ stdenv
, buildPythonApplication
, lib
, python
, fetchurl
, fetchFromGitHub
, fetchpatch
, lame
, mpv-unwrapped
, libpulseaudio
, pyqtwebengine
, decorator
, beautifulsoup4
, sqlalchemy
, pyaudio
, requests
, markdown
, matplotlib
, pytest
, glibcLocales
, nose
, jsonschema
, setuptools
, send2trash
, CoreAudio
# This little flag adds a huge number of dependencies, but we assume that
# everyone wants Anki to draw plots with statistics by default.
, plotsSupport ? true
# manual
, asciidoc
}:
let
# when updating, also update rev-manual to a recent version of
# https://github.com/ankitects/anki-docs
# The manual is distributed independently of the software.
version = "2.1.15";
sha256-pkg = "12dvyf3j9df4nrhhnqbzd9b21rpzkh4i6yhhangn2zf7ch0pclss";
rev-manual = "8f6387867ac37ef3fe9d0b986e70f898d1a49139";
sha256-manual = "0pm5slxn78r44ggvbksz7rv9hmlnsvn9z811r6f63dsc8vm6mfml";
manual = stdenv.mkDerivation {
pname = "anki-manual";
inherit version;
src = fetchFromGitHub {
owner = "ankitects";
repo = "anki-docs";
rev = rev-manual;
sha256 = sha256-manual;
};
dontInstall = true;
nativeBuildInputs = [ asciidoc ];
patchPhase = ''
# rsync isnt needed
# WEB is the PREFIX
# We remove any special ankiweb output generation
# and rename every .mako to .html
sed -e 's/rsync -a/cp -a/g' \
-e "s|\$(WEB)/docs|$out/share/doc/anki/html|" \
-e '/echo asciidoc/,/mv $@.tmp $@/c \\tasciidoc -b html5 -o $@ $<' \
-e 's/\.mako/.html/g' \
-i Makefile
# patch absolute links to the other language manuals
sed -e 's|https://apps.ankiweb.net/docs/|link:./|g' \
-i {manual.txt,manual.*.txt}
# theres an artifact in most input files
sed -e '/<%def.*title.*/d' \
-i *.txt
mkdir -p $out/share/doc/anki/html
'';
};
in
buildPythonApplication rec {
pname = "anki";
inherit version;
src = fetchurl {
urls = [
"https://apps.ankiweb.net/downloads/current/${pname}-${version}-source.tgz"
# "https://apps.ankiweb.net/downloads/current/${name}-source.tgz"
# "http://ankisrs.net/download/mirror/${name}.tgz"
# "http://ankisrs.net/download/mirror/archive/${name}.tgz"
];
sha256 = sha256-pkg;
};
outputs = [ "out" "doc" "man" ];
propagatedBuildInputs = [
pyqtwebengine
sqlalchemy
beautifulsoup4
send2trash
pyaudio
requests
decorator
markdown
jsonschema
setuptools
]
++ lib.optional plotsSupport matplotlib
++ lib.optional stdenv.isDarwin [ CoreAudio ]
;
checkInputs = [ pytest glibcLocales nose ];
nativeBuildInputs = [ pyqtwebengine.wrapQtAppsHook ];
buildInputs = [ lame mpv-unwrapped libpulseaudio ];
patches = [
# Disable updated version check.
./no-version-check.patch
(fetchpatch {
name = "fix-mpv-args.patch";
url = "https://sources.debian.org/data/main/a/anki/2.1.15+dfsg-3/debian/patches/fix-mpv-args.patch";
sha256 = "1dimnnawk64m5bbdbjrxw5k08q95l728n94cgkrrwxwavmmywaj2";
})
];
# Anki does not use setup.py
dontBuild = true;
postPatch = ''
# Remove QT translation files. We'll use the standard QT ones.
rm "locale/"*.qm
# hitting F1 should open the local manual
substituteInPlace anki/consts.py \
--replace 'HELP_SITE="http://ankisrs.net/docs/manual.html"' \
'HELP_SITE="${manual}/share/doc/anki/html/manual.html"'
'';
# UTF-8 locale needed for testing
LC_ALL = "en_US.UTF-8";
# tests fail with to many open files
doCheck = !stdenv.isDarwin;
# - Anki writes some files to $HOME during tests
# - Skip tests using network
checkPhase = ''
HOME=$TMP pytest --ignore tests/test_sync.py
'';
installPhase = ''
pp=$out/lib/${python.libPrefix}/site-packages
mkdir -p $out/bin
mkdir -p $out/share/applications
mkdir -p $doc/share/doc/anki
mkdir -p $man/share/man/man1
mkdir -p $out/share/mime/packages
mkdir -p $out/share/pixmaps
mkdir -p $pp
cat > $out/bin/anki <<EOF
#!${python}/bin/python
import aqt
aqt.run()
EOF
chmod 755 $out/bin/anki
cp -v anki.desktop $out/share/applications/
cp -v README* LICENSE* $doc/share/doc/anki/
cp -v anki.1 $man/share/man/man1/
cp -v anki.xml $out/share/mime/packages/
cp -v anki.{png,xpm} $out/share/pixmaps/
cp -rv locale $out/share/
cp -rv anki aqt web $pp/
# copy the manual into $doc
cp -r ${manual}/share/doc/anki/html $doc/share/doc/anki
'';
# now wrapPythonPrograms from postFixup will add both python and qt env variables
dontWrapQtApps = true;
preFixup = ''
makeWrapperArgs+=(
"''${qtWrapperArgs[@]}"
--prefix PATH ':' "${lame}/bin:${mpv-unwrapped}/bin"
)
'';
passthru = {
inherit manual;
};
meta = with lib; {
homepage = "https://apps.ankiweb.net/";
description = "Spaced repetition flashcard program";
longDescription = ''
Anki is a program which makes remembering things easy. Because it is a lot
more efficient than traditional study methods, you can either greatly
decrease your time spent studying, or greatly increase the amount you learn.
Anyone who needs to remember things in their daily life can benefit from
Anki. Since it is content-agnostic and supports images, audio, videos and
scientific markup (via LaTeX), the possibilities are endless. For example:
learning a language, studying for medical and law exams, memorizing
people's names and faces, brushing up on geography, mastering long poems,
or even practicing guitar chords!
'';
license = licenses.agpl3Plus;
platforms = platforms.mesaPlatforms;
maintainers = with maintainers; [ oxij Profpatsch ];
};
}