about summary refs log tree commit diff
path: root/pkgs/servers/search/khoj/default.nix
blob: 8bd07e9a1c6c155c44f9096d14d769b5b6d696b5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
{ lib
, stdenv
, fetchFromGitHub
, python3
, postgresql
, postgresqlTestHook
}:

python3.pkgs.buildPythonApplication rec {
  pname = "khoj";
  version = "1.0.1";
  pyproject = true;

  src = fetchFromGitHub {
    owner = "debanjum";
    repo = "khoj";
    rev = "refs/tags/${version}";
    hash = "sha256-lvOeYTrvW5MfhuJ3lj9n9TRlvpRwVP2vFeaEeJdqIec=";
  };

  env = {
    SETUPTOOLS_SCM_PRETEND_VERSION = version;
    DJANGO_SETTINGS_MODULE = "khoj.app.settings";
    postgresqlEnableTCP = 1;
  };

  nativeBuildInputs = with python3.pkgs; [
    hatch-vcs
    hatchling
  ];

  propagatedBuildInputs = with python3.pkgs; [
    aiohttp
    anyio
    authlib
    beautifulsoup4
    dateparser
    defusedxml
    django
    fastapi
    google-auth
    # gpt4all
    gunicorn
    httpx
    itsdangerous
    jinja2
    langchain
    lxml
    openai
    openai-whisper
    pgvector
    pillow
    psycopg2
    pydantic
    pymupdf
    python-multipart
    pyyaml
    # rapidocr-onnxruntime
    requests
    rich
    schedule
    sentence-transformers
    stripe
    tenacity
    tiktoken
    torch
    transformers
    tzdata
    uvicorn
  ];

  nativeCheckInputs = with python3.pkgs; [
    freezegun
    factory-boy
    pytest-xdist
    trio
    psutil
    pytest-django
    pytestCheckHook
  ] ++ [
    (postgresql.withPackages (p: with p; [ pgvector ]))
    postgresqlTestHook
  ];

  preCheck = ''
    export HOME=$(mktemp -d)
  '';

  pythonImportsCheck = [
    "khoj"
  ];

  disabledTests = [
    # Tests require network access
    "test_different_user_data_not_accessed"
    "test_get_api_config_types"
    "test_get_configured_types_via_api"
    "test_image_metadata"
    "test_image_search"
    "test_image_search_by_filepath"
    "test_image_search_query_truncated"
    "test_index_update"
    "test_index_update_with_no_auth_key"
    "test_notes_search"
    "test_notes_search_with_exclude_filter"
    "test_notes_search_with_include_filter"
    "test_parse_html_plaintext_file"
    "test_regenerate_index_with_new_entry"
    "test_regenerate_with_github_fails_without_pat"
    "test_regenerate_with_invalid_content_type"
    "test_regenerate_with_valid_content_type"
    "test_search_for_user2_returns_empty"
    "test_search_with_invalid_auth_key"
    "test_search_with_invalid_content_type"
    "test_search_with_no_auth_key"
    "test_search_with_valid_content_type"
    "test_text_index_same_if_content_unchanged"
    "test_text_indexer_deletes_embedding_before_regenerate"
    "test_text_search"
    "test_text_search_setup_batch_processes"
    "test_update_with_invalid_content_type"
    "test_user_no_data_returns_empty"

    # Tests require rapidocr-onnxruntime
    "test_multi_page_pdf_to_jsonl"
    "test_single_page_pdf_to_jsonl"
    "test_ocr_page_pdf_to_jsonl"
  ];

  disabledTestPaths = [
    # Tests require network access
    "tests/test_conversation_utils.py"
  ];

  meta = with lib; {
    description = "Natural Language Search Assistant for your Org-Mode and Markdown notes, Beancount transactions and Photos";
    homepage = "https://github.com/debanjum/khoj";
    changelog = "https://github.com/debanjum/khoj/releases/tag/${version}";
    license = licenses.agpl3Plus;
    maintainers = with maintainers; [ dit7ya ];
    # src/tcmalloc.cc:333] Attempt to free invalid pointer
    broken = stdenv.isDarwin;
  };
}