PyPI - khoj - Versions diffs - 1.33.3.dev32__py3-none-any.whl - Mend

khoj 1.33.3.dev32__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (393) hide show

khoj/interface/web/login.html ADDED Viewed

@@ -0,0 +1,310 @@
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
+    <title>Khoj - Login</title>
+    <link rel="icon" type="image/png" sizes="128x128" href="https://assets.khoj.dev/khoj_lantern_128x128.png">
+    <link rel="manifest" href="/static/khoj.webmanifest">
+    <link rel="stylesheet" href="/static/assets/khoj.css">
+    <meta property="og:image" content="https://assets.khoj.dev/khoj_hero.png">
+</head>
+<body>
+    <div class="split-container">
+        <!-- Left side with login -->
+        <div class="split left">
+            <div id="login-modal">
+                <img class="khoj-logo" src="https://assets.khoj.dev/khoj_lantern_128x128.png" alt="Khoj">
+                <div class="login-modal-title">Login to Khoj</div>
+                <!-- Sign Up/Login with Google OAuth -->
+                <div class="g_id_signin" data-shape="circle" data-text="continue_with" data-logo_alignment="center"
+                    data-size="large" data-type="standard"></div>
+                <div id="g_id_onload" data-client_id="{{ google_client_id }}" data-ux_mode="popup"
+                    data-use_fedcm_for_prompt="true" data-login_uri="{{ redirect_uri }}" data-auto-select="true"></div>
+                <!-- Divider -->
+                <div class="divider">OR</div>
+                <!-- Sign in with Magic Link -->
+                <div class="khoj-magic-link">
+                    <input type="email" id="email" placeholder="Email" autofocus required>
+                    <button id="magic-link-button">Get Login Link</button>
+                </div>
+            </div>
+            <!-- Footer links -->
+            <div class="footer-links">
+                <a href="https://khoj.dev/terms-of-service" target="_blank">Terms of Service</a>
+                <span class="divider-vertical"></span>
+                <a href="https://khoj.dev/privacy-policy" target="_blank">Privacy Policy</a>
+            </div>
+        </div>
+        <!-- Right side with content -->
+        <div class="split right">
+            <div class="right-content">
+                <h1>Unlock Your Second Brain</h1>
+                <p>Transform the way you think, create, and remember</p>
+                <div class="features">
+                    <div class="feature">
+                        <img src="/static/assets/icons/chat.svg" alt="Chat" width="24" height="24">
+                        <span>Get answers across your documents and the internet</span>
+                    </div>
+                    <div class="feature">
+                        <img src="/static/assets/icons/agents.svg" alt="Agents" width="24" height="24">
+                        <span>Create agents with the knowledge and tools to take on any role</span>
+                    </div>
+                    <div class="feature">
+                        <img src="/static/assets/icons/automation.svg" alt="Automations" width="24" height="24">
+                        <span>Automate away repetitive research</span>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+    <style>
+        body {
+            margin: 0;
+            height: 100vh;
+            font-family: 'Arial', sans-serif;
+            color: #333;
+            overflow: hidden;
+        }
+        .split-container {
+            display: flex;
+            height: 100vh;
+        }
+        .split {
+            flex: 1;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            flex-direction: column;
+        }
+        .left {
+            background-color: #fff;
+        }
+        .right {
+            background: linear-gradient(135deg, #FFA07A 0%, #c4e4c6 100%);
+            color: white;
+            position: relative;
+            overflow: hidden;
+        }
+        .right::before {
+            content: '';
+            position: absolute;
+            top: 0;
+            left: 0;
+            right: 0;
+            bottom: 0;
+            opacity: 0.1;
+        }
+        .right-content {
+            text-align: center;
+            padding: 2rem;
+            position: relative;
+            z-index: 1;
+        }
+        .right-content h1 {
+            font-size: 3rem;
+            margin-bottom: 1rem;
+            font-weight: 700;
+        }
+        .right-content p {
+            font-size: 1.2rem;
+            margin-bottom: 3rem;
+            opacity: 0.9;
+        }
+        .features {
+            display: flex;
+            flex-direction: column;
+            gap: 1.5rem;
+            align-items: center;
+        }
+        .feature {
+            display: flex;
+            align-items: center;
+            gap: 1rem;
+            font-size: 1.1rem;
+        }
+        .feature svg {
+            width: 24px;
+            height: 24px;
+            stroke: white;
+        }
+        .feature img {
+            width: 24px;
+            height: 24px;
+            filter: invert(100%) sepia(0%) saturate(0%) hue-rotate(0deg) brightness(100%) contrast(100%);
+            stroke: white;
+        }
+        #login-modal {
+            display: grid;
+            background: white;
+            border-radius: 10px;
+            padding: 40px;
+            box-shadow: 0 4px 20px rgba(0, 0, 0, 0.1);
+            text-align: center;
+            width: max-content;
+        }
+        .khoj-logo {
+            width: 80px;
+            margin-bottom: 20px;
+        }
+        .login-modal-title {
+            font-size: 24px;
+            font-weight: 600;
+            margin-bottom: 20px;
+        }
+        .khoj-magic-link {
+            display: flex;
+            flex-direction: column;
+            gap: 10px;
+        }
+        #email {
+            padding: 10px;
+            border: 1px solid #ccc;
+            border-radius: 5px;
+            width: 100%;
+            font-size: 16px;
+        }
+        #magic-link-button {
+            padding: 10px;
+            border: none;
+            border-radius: 5px;
+            background-color: #FFA07A;
+            color: white;
+            cursor: pointer;
+            font-size: 16px;
+            transition: background-color 0.3s;
+        }
+        #magic-link-button:hover {
+            background-color: #FFA07A
+        }
+        #magic-link-button:disabled {
+            background-color: #cccccc;
+            cursor: not-allowed;
+        }
+        .divider {
+            display: flex;
+            align-items: center;
+            text-align: center;
+            color: #000;
+            /* Adjust the text color as needed */
+            margin: 20px 0;
+            /* Adjust the margin as needed */
+        }
+        .divider::before,
+        .divider::after {
+            content: '';
+            flex: 1;
+            border-bottom: 1px solid #000;
+            /* Adjust the line color as needed */
+            margin: 0 10px;
+            /* Adjust the spacing as needed */
+        }
+        .g_id_signin {
+            margin: 0 auto;
+            display: block;
+        }
+        .footer-links {
+            width: 100%;
+            text-align: center;
+            font-size: 0.9em;
+            color: #666;
+            margin-top: 20px;
+        }
+        .footer-links a {
+            color: #666;
+            text-decoration: none;
+            margin: 0 10px;
+        }
+        .footer-links a:hover {
+            text-decoration: underline;
+        }
+        .divider-vertical {
+            display: inline-block;
+            width: 1px;
+            height: 12px;
+            background-color: #666;
+            margin: 0 10px;
+            vertical-align: middle;
+        }
+        @media (max-width: 768px) {
+            .split-container {
+                flex-direction: column;
+            }
+            .right {
+                display: none;
+            }
+            .left {
+                padding: 2rem;
+            }
+        }
+    </style>
+    <script>
+        const magicLinkButton = document.getElementById('magic-link-button');
+        const emailInput = document.getElementById('email');
+        magicLinkButton.addEventListener('click', async () => {
+            const email = emailInput.value;
+            if (!email) {
+                alert('Please enter a valid email address');
+                return;
+            }
+            if (!email.includes('@')) {
+                alert('Please enter a valid email address');
+                return;
+            }
+            magicLinkButton.disabled = true;
+            magicLinkButton.innerText = 'Check your email for a sign-in link!';
+            const response = await fetch('/auth/magic', {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({ "email": email }),
+            });
+            if (response.status === 200) {
+                console.log('Magic link sent to your email');
+            } else {
+                alert('Failed to send magic link');
+                magicLinkButton.disabled = false;
+                magicLinkButton.innerText = 'Get Login Link';
+            }
+        });
+    </script>
+    <script src="https://accounts.google.com/gsi/client" async defer></script>
+</body>
+</html>

khoj/interface/web/utils.html ADDED Viewed

@@ -0,0 +1,48 @@
+{% macro heading_pane(user_photo, username, is_active, has_documents) -%}
+    <div class="khoj-header">
+        <a class="khoj-logo" href="/">
+            <img class="khoj-logo" src="/static/assets/icons/khoj-logo-sideways-500.png?v={{ khoj_version }}" alt="Khoj"></img>
+        </a>
+        <nav class="khoj-nav">
+            <a id="chat-nav" class="khoj-nav" href="/chat">
+                <img class="nav-icon" src="/static/assets/icons/chat.svg" alt="Chat">
+                <span class="khoj-nav-item-text">Chat</span></a>
+            <a id="agents-nav" class="khoj-nav" href="/agents">
+                <img id="agents-icon" class="nav-icon" src="/static/assets/icons/agents.svg" alt="Agents">
+                <span class="khoj-nav-item-text">Agents</span></a>
+            <a id="automations-nav" class="khoj-nav" href="/automations">
+                <img class="nav-icon" src="/static/assets/icons/automation.svg" alt="Automation">
+                <span class="khoj-nav-item-text">Automate</span></a>
+            {% if has_documents %}
+            <a id="search-nav" class="khoj-nav" href="/search">
+                <img class="nav-icon" src="/static/assets/icons/search.svg" alt="Search">
+                <span class="khoj-nav-item-text">Search</span></a>
+            {% endif %}
+            <!-- Dropdown Menu -->
+            {% if username %}
+                <div id="khoj-nav-menu-container" class="khoj-nav dropdown">
+                    {% if user_photo and user_photo != "None" %}
+                        {% if is_active %}
+                        <img id="profile-picture" class="circle subscribed" src="{{ user_photo }}" alt="{{ username[0].upper() }}" onclick="toggleMenu()" referrerpolicy="no-referrer">
+                        {% else %}
+                        <img id="profile-picture" class="circle" src="{{ user_photo }}" alt="{{ username[0].upper() }}" onclick="toggleMenu()" referrerpolicy="no-referrer">
+                        {% endif %}
+                    {% else %}
+                        {% if is_active %}
+                        <div id="profile-picture" class="circle user-initial subscribed" alt="{{ username[0].upper() }}" onclick="toggleMenu()">{{ username[0].upper() }}</div>
+                        {% else %}
+                        <div id="profile-picture" class="circle user-initial" alt="{{ username[0].upper() }}" onclick="toggleMenu()">{{ username[0].upper() }}</div>
+                        {% endif %}
+                    {% endif %}
+                    <div id="khoj-nav-menu" class="khoj-nav-dropdown-content">
+                        <div class="khoj-nav-username"> {{ username }} </div>
+                        <a id="settings-nav" class="khoj-nav" href="/settings">Settings</a>
+                        <a id="github-nav" class="khoj-nav" href="https://github.com/khoj-ai/khoj">GitHub</a>
+                        <a id="help-nav" class="khoj-nav" href="https://docs.khoj.dev" target="_blank">Help</a>
+                        <a class="khoj-nav" href="/auth/logout">Logout</a>
+                    </div>
+                </div>
+            {% endif %}
+        </nav>
+    </div>
+{%- endmacro %}

khoj/main.py ADDED Viewed

@@ -0,0 +1,249 @@
+""" Main module for Khoj
+   isort:skip_file
+"""
+from contextlib import redirect_stdout
+import logging
+import io
+import os
+import atexit
+import sys
+import locale
+from rich.logging import RichHandler
+import threading
+import warnings
+from importlib.metadata import version
+from khoj.utils.helpers import in_debug_mode, is_env_var_true
+# Ignore non-actionable warnings
+warnings.filterwarnings("ignore", message=r"snapshot_download.py has been made private", category=FutureWarning)
+warnings.filterwarnings("ignore", message=r"legacy way to download files from the HF hub,", category=FutureWarning)
+import uvicorn
+import django
+from apscheduler.schedulers.background import BackgroundScheduler
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.staticfiles import StaticFiles
+import schedule
+from django.core.asgi import get_asgi_application
+from django.core.management import call_command
+# Initialize Django
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "khoj.app.settings")
+django.setup()
+# Setup Logger
+rich_handler = RichHandler(rich_tracebacks=True)
+rich_handler.setFormatter(fmt=logging.Formatter(fmt="%(name)s: %(message)s", datefmt="[%H:%M:%S.%f]"))
+logging.basicConfig(handlers=[rich_handler])
+logging.getLogger("uvicorn.error").setLevel(logging.INFO)
+logger = logging.getLogger("khoj")
+# Initialize Django Database
+db_migrate_output = io.StringIO()
+with redirect_stdout(db_migrate_output):
+    call_command("migrate", "--noinput")
+# Initialize Django Static Files
+collectstatic_output = io.StringIO()
+with redirect_stdout(collectstatic_output):
+    call_command("collectstatic", "--noinput")
+# Initialize the Application Server
+if in_debug_mode():
+    app = FastAPI(debug=True)
+else:
+    app = FastAPI(docs_url=None)  # Disable Swagger UI in production
+# Get Django Application
+django_app = get_asgi_application()
+# Add CORS middleware
+KHOJ_DOMAIN = os.getenv("KHOJ_DOMAIN", "app.khoj.dev")
+scheme = "https" if not is_env_var_true("KHOJ_NO_HTTPS") else "http"
+custom_origins = [f"{scheme}://{KHOJ_DOMAIN.strip()}", f"{scheme}://{KHOJ_DOMAIN.strip()}:*"]
+default_origins = [
+    "app://obsidian.md",  # To allow access from Obsidian desktop app
+    "capacitor://localhost",  # To allow access from Obsidian iOS app using Capacitor.JS
+    "http://localhost",  # To allow access from Obsidian Android app
+    "http://localhost:*",  # To allow access from localhost
+    "http://127.0.0.1:*",  # To allow access from localhost
+    "app://khoj.dev",  # To allow access from Khoj desktop app
+]
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=default_origins + custom_origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+# Set Locale
+locale.setlocale(locale.LC_ALL, "")
+# We import these packages after setting up Django so that Django features are accessible to the app.
+from khoj.configure import configure_routes, initialize_server, configure_middleware
+from khoj.utils import state
+from khoj.utils.cli import cli
+from khoj.utils.initialization import initialization
+from khoj.database.adapters import ProcessLockAdapters
+from khoj.database.models import ProcessLock
+from django.db.utils import IntegrityError
+SCHEDULE_LEADER_NAME = ProcessLock.Operation.SCHEDULE_LEADER
+def shutdown_scheduler():
+    logger.info("🌑 Shutting down Khoj")
+    if state.schedule_leader_process_lock:
+        logger.info("🔓 Schedule Leader released")
+        ProcessLockAdapters.remove_process_lock(state.schedule_leader_process_lock)
+    try:
+        state.scheduler.shutdown()
+    except Exception as e:
+        logger.debug(f"Did not shutdown scheduler: {e}")
+def run(should_start_server=True):
+    # Turn Tokenizers Parallelism Off. App does not support it.
+    os.environ["TOKENIZERS_PARALLELISM"] = "false"
+    # Load config from CLI
+    state.cli_args = sys.argv[1:]
+    args = cli(state.cli_args)
+    set_state(args)
+    # Set Logging Level
+    if args.verbose == 0:
+        logger.setLevel(logging.INFO)
+    elif args.verbose >= 1:
+        logger.setLevel(logging.DEBUG)
+    logger.info(f"🚒 Initializing Khoj v{state.khoj_version}")
+    logger.info(f"📦 Initializing DB:\n{db_migrate_output.getvalue().strip()}")
+    logger.debug(f"🌍 Initializing Web Client:\n{collectstatic_output.getvalue().strip()}")
+    initialization(not args.non_interactive)
+    # Create app directory, if it doesn't exist
+    state.config_file.parent.mkdir(parents=True, exist_ok=True)
+    # Set Log File
+    fh = logging.FileHandler(state.config_file.parent / "khoj.log", encoding="utf-8")
+    fh.setLevel(logging.DEBUG)
+    logger.addHandler(fh)
+    logger.info("🌘 Starting Khoj")
+    # Setup task scheduler
+    poll_task_scheduler()
+    # Setup Background Scheduler
+    from django_apscheduler.jobstores import DjangoJobStore
+    state.scheduler = BackgroundScheduler(
+        {
+            "apscheduler.timezone": "UTC",
+            "apscheduler.job_defaults.misfire_grace_time": "60",  # Useful to run scheduled jobs even when worker delayed because it was busy or down
+            "apscheduler.job_defaults.coalesce": "true",  # Combine multiple jobs into one if they are scheduled at the same time
+        }
+    )
+    state.scheduler.add_jobstore(DjangoJobStore(), "default")
+    # We use this mechanism to only elect one schedule leader in a distributed environment. This one will be responsible for actually executing the scheduled tasks. The others will still be capable of adding and removing tasks, but they will not execute them. This is to decrease the overall burden on the database and the system.
+    try:
+        schedule_leader_process_lock = ProcessLockAdapters.get_process_lock(SCHEDULE_LEADER_NAME)
+        if schedule_leader_process_lock:
+            logger.info("🔒 Schedule Leader is already running")
+            state.scheduler.start(paused=True)
+        else:
+            logger.info("🔒 Schedule Leader elected")
+            created_process_lock = ProcessLockAdapters.set_process_lock(
+                SCHEDULE_LEADER_NAME, max_duration_in_seconds=43200
+            )
+            state.scheduler.start()
+            state.schedule_leader_process_lock = created_process_lock
+    except IntegrityError:
+        logger.info("🔒 Schedule Leader running elsewhere")
+        state.scheduler.start(paused=True)
+    finally:
+        logger.info("Started Background Scheduler")
+    # Start Server
+    configure_routes(app)
+    #  Mount Django and Static Files
+    app.mount("/server", django_app, name="server")
+    static_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "static")
+    if not os.path.exists(static_dir):
+        os.mkdir(static_dir)
+    app.mount(f"/static", StaticFiles(directory=static_dir), name=static_dir)
+    # Configure Middleware
+    configure_middleware(app, state.ssl_config)
+    initialize_server(args.config)
+    # If the server is started through gunicorn (external to the script), don't start the server
+    if should_start_server:
+        start_server(app, host=args.host, port=args.port, socket=args.socket)
+        # Teardown
+        shutdown_scheduler()
+def set_state(args):
+    state.config_file = args.config_file
+    state.config = args.config
+    state.verbose = args.verbose
+    state.host = args.host
+    state.port = args.port
+    state.ssl_config = (
+        {"ssl_certfile": args.sslcert, "ssl_keyfile": args.sslkey} if args.sslcert and args.sslkey else None
+    )
+    state.anonymous_mode = args.anonymous_mode
+    state.khoj_version = version("khoj")
+    state.chat_on_gpu = args.chat_on_gpu
+def start_server(app, host=None, port=None, socket=None):
+    logger.info("🌖 Khoj is ready to use")
+    if socket:
+        uvicorn.run(app, proxy_headers=True, uds=socket, log_level="debug", use_colors=True, log_config=None)
+    else:
+        uvicorn.run(
+            app,
+            host=host,
+            port=port,
+            log_level="debug" if state.verbose > 1 else "info",
+            use_colors=True,
+            log_config=None,
+            timeout_keep_alive=60,
+            **state.ssl_config if state.ssl_config else {},
+        )
+    logger.info("🌒 Stopping Khoj")
+def poll_task_scheduler():
+    timer_thread = threading.Timer(60.0, poll_task_scheduler)
+    timer_thread.daemon = True
+    timer_thread.start()
+    schedule.run_pending()
+if __name__ == "__main__":
+    run()
+else:
+    if "gunicorn" in sys.modules:
+        run(should_start_server=False)
+        atexit.register(shutdown_scheduler)

khoj/manage.py ADDED Viewed

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "khoj.app.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+if __name__ == "__main__":
+    main()

khoj/migrations/__init__.py ADDED Viewed

File without changes