repo
stringclasses
454 values
file_path
stringlengths
5
201
extension
stringclasses
1 value
content
stringlengths
8
509k
num_lines
int64
3
16.9k
size_bytes
int64
8
511k
ArchiveBox
archivebox/tests/test_auth_ldap.py
.py
""" LDAP authentication tests for ArchiveBox. Tests LDAP configuration, validation, and integration with Django. Per CLAUDE.md: NO MOCKS, NO SKIPS - all tests use real code paths. """ from importlib.util import find_spec from archivebox.tests.conftest import run_archivebox_cmd class TestLDAPConfig: """Test LDA...
211
8,168
ArchiveBox
archivebox/tests/conftest.py
.py
"""archivebox/tests/conftest.py - Pytest fixtures for CLI tests.""" import os import json import re import secrets import signal import select import socket import subprocess import sys import tempfile import textwrap import time import shutil import ctypes from datetime import timedelta from http.server import BaseHT...
1,840
64,514
ArchiveBox
archivebox/tests/test_cli_schedule.py
.py
#!/usr/bin/env python3 """CLI-specific tests for archivebox schedule.""" from archivebox.tests.conftest import run_archivebox_cmd import pytest from archivebox.crawls.models import Crawl, CrawlSchedule from archivebox.tests.test_orm_helpers import use_archivebox_db from .conftest import ( cli_env, get_counts...
206
6,295
ArchiveBox
archivebox/ldap/apps.py
.py
"""Django app configuration for LDAP authentication.""" __package__ = "archivebox.ldap" from django.apps import AppConfig class LDAPConfig(AppConfig): """Django app config for LDAP authentication.""" default_auto_field = "django.db.models.BigAutoField" name = "archivebox.ldap" verbose_name = "LDAP ...
14
336
ArchiveBox
archivebox/ldap/__init__.py
.py
""" LDAP authentication module for ArchiveBox. This module provides native LDAP authentication support using django-auth-ldap. It only activates if: 1. LDAP_ENABLED=True in config 2. Required LDAP libraries (python-ldap, django-auth-ldap) are installed To install LDAP dependencies: pip install archivebox[ldap] O...
18
495
ArchiveBox
archivebox/ldap/auth.py
.py
""" LDAP authentication backend for ArchiveBox. This module extends django-auth-ldap to support the LDAP_CREATE_SUPERUSER flag. """ __package__ = "archivebox.ldap" import importlib try: BaseLDAPBackend = importlib.import_module("django_auth_ldap.backend").LDAPBackend except ImportError: class BaseLDAPBacke...
51
1,464
ArchiveBox
archivebox/api/middleware.py
.py
__package__ = "archivebox.api" from django.http import HttpResponse class ApiCorsMiddleware: """Attach permissive CORS headers for API routes (token-based auth).""" def __init__(self, get_response): self.get_response = get_response def __call__(self, request): if request.path.startswith...
33
1,197
ArchiveBox
archivebox/api/v1_api.py
.py
__package__ = "archivebox.api" from io import StringIO from traceback import format_exception from contextlib import redirect_stdout, redirect_stderr from django.http import HttpRequest, HttpResponse from django.core.exceptions import ObjectDoesNotExist, EmptyResultSet, PermissionDenied from django.contrib.auth.mode...
115
4,676
ArchiveBox
archivebox/api/admin.py
.py
__package__ = "archivebox.api" from django import forms from django.contrib import admin from django.http import HttpRequest from django.utils.text import capfirst from signal_webhooks.admin import WebhookAdmin, WebhookModelForm from signal_webhooks.settings import webhook_settings from signal_webhooks.utils import ge...
121
3,925
ArchiveBox
archivebox/api/webhooks.py
.py
__package__ = "archivebox.api" from typing import Any from collections.abc import Callable import logging from django.db import transaction from signal_webhooks.handlers import sync_task_handler logger = logging.getLogger(__name__) def warning_error_handler(hook: Any, error: Exception | None) -> None: if erro...
33
993
ArchiveBox
archivebox/api/models.py
.py
__package__ = "archivebox.api" import secrets from archivebox.uuid_compat import CompactUUIDField, uuid7 from django.conf import settings from django.db import models from django.utils import timezone from django_stubs_ext.db.models import TypedModelMeta from signal_webhooks.models import WebhookBase from archivebox...
55
1,972
ArchiveBox
archivebox/api/apps.py
.py
__package__ = "archivebox.api" from django.apps import AppConfig class APIConfig(AppConfig): name = "archivebox.api" label = "api" def register_admin(admin_site): from archivebox.api.admin import register_admin register_admin(admin_site)
15
260
ArchiveBox
archivebox/api/v1_crawls.py
.py
__package__ = "archivebox.api" import json from pathlib import Path from uuid import UUID from datetime import datetime from django.http import FileResponse, HttpRequest from django.shortcuts import redirect from django.utils import timezone from django.contrib.auth import get_user_model from django.contrib.auth.mode...
268
9,252
ArchiveBox
archivebox/api/v1_core.py
.py
__package__ = "archivebox.api" import math import json import mimetypes import re from html import unescape from collections import defaultdict from pathlib import Path, PurePosixPath from uuid import UUID from typing import Union, Any, Annotated from datetime import datetime, time from django.db import transaction f...
1,469
53,206
ArchiveBox
archivebox/api/v1_machine.py
.py
__package__ = "archivebox.api" from uuid import UUID from typing import Annotated from datetime import datetime from django.http import HttpRequest from ninja import FilterLookup, FilterSchema, Query, Router, Schema from ninja.pagination import paginate from archivebox.api.v1_core import CustomPagination router =...
162
5,228
ArchiveBox
archivebox/api/auth.py
.py
__package__ = "archivebox.api" from datetime import timedelta from django.utils import timezone from django.http import HttpRequest from django.contrib.auth import authenticate from django.contrib.auth.models import User from ninja.security import HttpBearer, APIKeyQuery, APIKeyHeader from ninja.errors import HttpEr...
138
4,880
ArchiveBox
archivebox/api/urls.py
.py
__package__ = "archivebox.api" from urllib.parse import quote from django.http import HttpRequest, HttpResponseRedirect from django.shortcuts import redirect from django.urls import path from django.views.generic.base import RedirectView from archivebox.core.routes_util import build_web_url from .v1_api import urls ...
27
907
ArchiveBox
archivebox/api/v1_cli.py
.py
__package__ = "archivebox.api" import json from io import StringIO from typing import Any from enum import Enum from django.http import HttpRequest from ninja import Router, Schema from ninja.errors import HttpError from pydantic import Field from archivebox.misc.util import ansi_to_html from archivebox.core.models...
321
11,200
ArchiveBox
archivebox/api/v1_personas.py
.py
__package__ = "archivebox.api" import json from datetime import datetime from typing import Any from uuid import UUID from django.db.models import Q from django.http import HttpRequest from ninja import Router, Schema from ninja.pagination import paginate from pydantic import Field from archivebox.api.v1_core import...
169
5,257
ArchiveBox
archivebox/api/v1_auth.py
.py
__package__ = "archivebox.api" from django.http import HttpRequest from ninja import Router, Schema from archivebox.api.auth import auth_using_token, auth_using_password, get_or_create_api_token router = Router(tags=["Authentication"], auth=None) class PasswordAuthSchema(Schema): """Schema for a /get_api_tok...
66
1,839
ArchiveBox
archivebox/mcp/server.py
.py
"""Model Context Protocol server for ArchiveBox. The server exposes five agent-friendly workflow tools backed by ArchiveBox's existing Click CLI and newline-delimited JSON-RPC. """ import json import sys import traceback from dataclasses import dataclass from typing import Any import click from click.testing import ...
568
21,126
ArchiveBox
archivebox/mcp/apps.py
.py
__package__ = "archivebox.mcp" from django.apps import AppConfig class MCPConfig(AppConfig): name = "mcp" verbose_name = "Model Context Protocol Server" default_auto_field = "django.db.models.BigAutoField"
10
221
ArchiveBox
archivebox/mcp/__init__.py
.py
__package__ = "archivebox.mcp" """ Model Context Protocol (MCP) server for ArchiveBox. Exposes all ArchiveBox CLI commands as MCP tools via dynamic Click introspection. Provides a JSON-RPC 2.0 interface over stdio for AI agents to control ArchiveBox. """
9
257
ArchiveBox
archivebox/cli/archivebox_archiveresult.py
.py
#!/usr/bin/env python3 """ archivebox archiveresult <action> [args...] [--filters] Manage ArchiveResult records (plugin extraction results). Actions: create - Create ArchiveResults for Snapshots (queue extractions) list - List ArchiveResults as JSONL (with optional filters) update - Update ArchiveRe...
388
12,684
ArchiveBox
archivebox/cli/archivebox_process.py
.py
#!/usr/bin/env python3 """ archivebox process <action> [--filters] Manage Process records (system-managed, mostly read-only). Process records track executions of binaries during extraction. They are created automatically by the system and are primarily for debugging. Actions: list - List Processes as JSONL (...
111
3,121
ArchiveBox
archivebox/cli/cli_util.py
.py
""" Shared CLI utilities for ArchiveBox commands. This module contains common utilities used across multiple CLI commands, extracted to avoid code duplication. """ __package__ = "archivebox.cli" def apply_filters(queryset, filter_kwargs: dict, limit: int | None = None): """ Apply Django-style filters from C...
45
1,297
ArchiveBox
archivebox/cli/archivebox_manage.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import rich_click as click from archivebox.misc.util import docstring, enforce_types @enforce_types def manage(args: list[str] | None = None) -> None: """Run an ArchiveBox Django management command""" from archivebox.config.common import get_config ...
36
1,148
ArchiveBox
archivebox/cli/archivebox_oneshot.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" __command__ = "archivebox oneshot" import subprocess import sys from pathlib import Path import rich_click as click from archivebox.config import CONSTANTS from archivebox.config.common import get_config @click.command(add_help_option=False, context_settings=d...
50
1,527
ArchiveBox
archivebox/cli/archivebox_tag.py
.py
#!/usr/bin/env python3 """ archivebox tag <action> [args...] [--filters] Manage Tag records. Actions: create - Create Tags list - List Tags as JSONL (with optional filters) update - Update Tags from stdin JSONL delete - Delete Tags from stdin JSONL Examples: # Create archivebox tag cre...
300
7,944
ArchiveBox
archivebox/cli/archivebox_status.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" from pathlib import Path import rich_click as click from rich import print from archivebox.misc.util import enforce_types, docstring from archivebox.config import CONSTANTS from archivebox.config.common import get_config from archivebox.misc.system import get_di...
167
7,232
ArchiveBox
archivebox/cli/archivebox_init.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import os import sys from pathlib import Path from rich import print import rich_click as click from archivebox.misc.util import docstring, enforce_types def _display_data_path(path: Path, data_dir: Path) -> str: path = Path(path).resolve() data_dir = ...
203
8,587
ArchiveBox
archivebox/cli/archivebox_list.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" __command__ = "archivebox list" import sys import rich_click as click from archivebox.cli.archivebox_snapshot import list_snapshots, snapshot_filter_options, snapshot_output_options @click.command() @snapshot_output_options @snapshot_filter_options(default_fil...
23
475
ArchiveBox
archivebox/cli/archivebox_add.py
.py
#!/usr/bin/env python3 from __future__ import annotations __package__ = "archivebox.cli" __command__ = "archivebox add" import sys import os import json from pathlib import Path from typing import Any, TYPE_CHECKING import rich_click as click from archivebox.config import CONSTANTS from archivebox.misc.util import...
430
20,097
ArchiveBox
archivebox/cli/archivebox_binary.py
.py
#!/usr/bin/env python3 """ archivebox binary <action> [args...] [--filters] Manage Binary records (detected executables like chrome, wget, etc.). Actions: create - Create/register a Binary list - List Binaries as JSONL (with optional filters) update - Update Binaries from stdin JSONL delete - D...
320
9,147
ArchiveBox
archivebox/cli/__init__.py
.py
__package__ = "archivebox.cli" __command__ = "archivebox" import os import sys from importlib import import_module import rich_click as click from rich.console import Console from archivebox.config.version import VERSION STDERR = Console(stderr=True) if "--debug" in sys.argv: os.environ["DEBUG"] = "True" s...
221
8,956
ArchiveBox
archivebox/cli/archivebox_config.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import sys import toml import rich_click as click from rich import print from pathlib import Path from archivebox.misc.util import docstring, enforce_types from archivebox.misc.toml_util import CustomTOMLEncoder def _format_toml(config: dict) -> str: return...
200
8,515
ArchiveBox
archivebox/cli/archivebox_mcp.py
.py
#!/usr/bin/env python3 """ archivebox mcp Start the Model Context Protocol (MCP) server in stdio mode. Exposes all ArchiveBox CLI commands as MCP tools for AI agents. """ __package__ = "archivebox.cli" __command__ = "archivebox mcp" import rich_click as click from archivebox.misc.util import docstring, enforce_type...
50
1,184
ArchiveBox
archivebox/cli/archivebox_server.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import sys import os import socket import subprocess import time from collections.abc import Iterable import rich_click as click from rich import print from archivebox.config import CONSTANTS from archivebox.misc.util import docstring, enforce_types import re ...
431
17,757
ArchiveBox
archivebox/cli/archivebox_crawl.py
.py
#!/usr/bin/env python3 """ archivebox crawl <action> [args...] [--filters] Manage Crawl records. Actions: create - Create Crawl jobs from URLs list - List Crawls as JSONL (with optional filters) update - Update Crawls from stdin JSONL delete - Delete Crawls from stdin JSONL Examples: # Cre...
407
13,006
ArchiveBox
archivebox/cli/archivebox_update.py
.py
#!/usr/bin/env python3 from __future__ import annotations __package__ = "archivebox.cli" import os import asyncio import shlex import time from typing import TYPE_CHECKING, Any from collections.abc import Iterable from pathlib import Path import rich_click as click from archivebox.misc.util import enforce_types, d...
1,047
43,848
ArchiveBox
archivebox/cli/archivebox_search.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" __command__ = "archivebox search" from archivebox.cli.archivebox_list import main if __name__ == "__main__": main()
11
178
ArchiveBox
archivebox/cli/archivebox_install.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import os import shutil import re from pathlib import Path import rich_click as click from rich import print from archivebox.misc.util import docstring, enforce_types def _resolve_install_targets( requested_names: tuple[str, ...], ) -> tuple[list[str], lis...
228
8,952
ArchiveBox
archivebox/cli/archivebox_version.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import sys import os import json import asyncio import platform import re from pathlib import Path from collections.abc import Iterable import rich_click as click from archivebox.misc.util import docstring, enforce_types def _format_binary_abspath( abspath...
561
22,518
ArchiveBox
archivebox/cli/archivebox_run.py
.py
#!/usr/bin/env python3 """ archivebox run [--daemon] [--crawl-id=...] [--snapshot-id=...] [--binary-id=...] Unified command for processing queued work on the shared abx-dl bus. Modes: - With stdin JSONL: Process piped records, exit when complete - Without stdin (TTY): Run the background runner in foreground ...
478
18,572
ArchiveBox
archivebox/cli/archivebox_pluginmap.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import rich_click as click from archivebox.misc.util import docstring, enforce_types EVENT_FLOW_DIAGRAM = """ ┌─────────────────────────────────────────────────────────────────────────────┐ │ ArchiveBox / abx-dl Flow ...
234
10,359
ArchiveBox
archivebox/cli/archivebox_snapshot.py
.py
#!/usr/bin/env python3 """ archivebox snapshot <action> [args...] [--filters] Manage Snapshot records. Actions: create - Create Snapshots from URLs or Crawl JSONL list - List Snapshots as JSONL (with optional filters) update - Update Snapshots from stdin JSONL delete - Delete Snapshots from std...
543
19,242
ArchiveBox
archivebox/cli/archivebox_shell.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" from collections.abc import Iterable import rich_click as click from archivebox.misc.util import docstring def shell(args: Iterable[str] = ()) -> None: """Enter an interactive ArchiveBox Django shell""" from django.core.management import call_command,...
30
711
ArchiveBox
archivebox/cli/archivebox_extract.py
.py
#!/usr/bin/env python3 """ archivebox extract [snapshot_ids...] [--plugins=NAMES] Run plugins on Snapshots. Accepts snapshot IDs as arguments, from stdin, or via JSONL. Input formats: - Snapshot UUIDs (one per line) - JSONL: {"type": "Snapshot", "id": "...", "url": "..."} - JSONL: {"type": "ArchiveResult...
466
19,483
ArchiveBox
archivebox/cli/archivebox_help.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" __command__ = "archivebox help" import ast import importlib.util import os from pathlib import Path import click from rich import print from rich.panel import Panel def _command_doc(cmd: str, import_path: str) -> str: def first_doc_line(docstring: str | None...
155
8,177
ArchiveBox
archivebox/cli/archivebox_schedule.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" import rich_click as click from rich import print from archivebox.misc.util import enforce_types, docstring @enforce_types def schedule( add: bool = False, show: bool = False, clear: bool = False, foreground: bool = False, run_all: bool = Fa...
187
7,369
ArchiveBox
archivebox/cli/archivebox_machine.py
.py
#!/usr/bin/env python3 """ archivebox machine <action> [--filters] Manage Machine records (system-managed, mostly read-only). Machine records track the host machines where ArchiveBox runs. They are created automatically by the system and are primarily for debugging. Actions: list - List Machines as JSONL (wi...
103
2,697
ArchiveBox
archivebox/cli/archivebox_remove.py
.py
#!/usr/bin/env python3 __package__ = "archivebox.cli" __command__ = "archivebox remove" import time from pathlib import Path from collections.abc import Iterable import rich_click as click from django.db.models import QuerySet from archivebox.config import CONSTANTS from archivebox.config.django import setup_djang...
138
4,840
ArchiveBox
archivebox/cli/archivebox_persona.py
.py
#!/usr/bin/env python3 """ archivebox persona <action> [args...] [--filters] Manage Persona records (browser profiles for archiving). Actions: create - Create Personas list - List Personas as JSONL (with optional filters) update - Update Personas from stdin JSONL delete - Delete Personas from s...
580
18,864
ArchiveBox
archivebox/opencode/apps.py
.py
from django.apps import AppConfig class OpencodeConfig(AppConfig): name = "archivebox.opencode" label = "opencode_plugin"
7
132
ArchiveBox
archivebox/opencode/views.py
.py
from __future__ import annotations import atexit import base64 import os import re import shutil import subprocess import threading import time from pathlib import Path from typing import Any from urllib.parse import urljoin, urlsplit import httpx import requests from abx_plugins.plugins import opencode as opencode_p...
717
27,882
ArchiveBox
archivebox/opencode/urls.py
.py
from django.urls import path, re_path from archivebox.opencode.views import agent_view, opencode_proxy_view urlpatterns = [ path("", agent_view, name="opencode-agent"), re_path( r"^opencode(?:/(?P<path>.*))?$", opencode_proxy_view, name="opencode-proxy", ), ]
14
299
ArchiveBox
archivebox/personas/admin.py
.py
__package__ = "archivebox.personas" import shutil from django.contrib import admin, messages from django.utils.html import format_html, format_html_join from archivebox.base_models.admin import BaseModelAdmin, ConfigEditorMixin from archivebox.personas.forms import PersonaAdminForm from archivebox.personas.importers...
191
7,118
ArchiveBox
archivebox/personas/importers.py
.py
""" Shared persona browser discovery/import helpers. These helpers are used by both the CLI and the Django admin so Persona import behavior stays consistent regardless of where it is triggered from. """ from __future__ import annotations import json import os import platform import shutil import subprocess import sy...
880
30,362
ArchiveBox
archivebox/personas/models.py
.py
""" Persona management for ArchiveBox. A Persona represents a browser profile/identity used for archiving. Each persona has its own: - Chrome user data directory (for cookies, localStorage, extensions, etc.) - Cookies file - Config overrides """ __package__ = "archivebox.personas" import shutil import os from contex...
364
13,639
ArchiveBox
archivebox/personas/apps.py
.py
from django.apps import AppConfig class PersonasConfig(AppConfig): default_auto_field = "django.db.models.BigAutoField" name = "archivebox.personas" label = "personas"
8
182
ArchiveBox
archivebox/personas/forms.py
.py
__package__ = "archivebox.personas" from typing import Any from django import forms from django.utils.safestring import mark_safe from archivebox.config.common import get_config from archivebox.core.permissions import PERMISSIONS_CHOICES from archivebox.plugins.forms import PluginConfigFormMixin from archivebox.pers...
206
8,960
ArchiveBox
archivebox/base_models/admin.py
.py
"""Base admin classes for models using UUIDv7.""" __package__ = "archivebox.base_models" import json import uuid from collections.abc import Mapping from typing import ClassVar, NotRequired, TypedDict, cast from django import forms from django.contrib import admin from django.db import DatabaseError, models from dja...
931
46,271
ArchiveBox
archivebox/base_models/models.py
.py
"""Base models using UUIDv7 for all id fields.""" __package__ = "archivebox.base_models" import json import shutil from typing import Any from archivebox.uuid_compat import CompactUUIDField, uuid7 from pathlib import Path from django.db import models from django.db.models import F from django.db import transaction ...
304
10,662
ArchiveBox
archivebox/workers/admin.py
.py
""" Workers admin module. Background runner processes do not need Django admin registration. """ __package__ = "archivebox.workers" def register_admin(admin_site): """No models to register - workers are process-based, not Django models.""" pass
13
257
ArchiveBox
archivebox/workers/models.py
.py
__package__ = "archivebox.workers" import inspect import logging from typing import Any, ClassVar, Protocol, cast from collections.abc import Iterable from datetime import UTC, datetime, timedelta from pathlib import Path from statemachine.callbacks import SPECS_ALL from statemachine.dispatcher import Listener, Liste...
665
27,268
ArchiveBox
archivebox/workers/apps.py
.py
from django.apps import AppConfig class WorkersConfig(AppConfig): default_auto_field = "django.db.models.BigAutoField" name = "archivebox.workers" label = "workers"
8
179
ArchiveBox
archivebox/workers/__init__.py
.py
__package__ = "archivebox.workers" __order__ = 100 def register_admin(admin_site): from archivebox.workers.admin import register_admin register_admin(admin_site)
9
173
ArchiveBox
archivebox/workers/supervisord_parent_watchdog.py
.py
#!/usr/bin/env python3 import argparse import os import time import psutil def matching_process(pid: int, started_at: float) -> psutil.Process | None: try: process = psutil.Process(pid) if process.status() == psutil.STATUS_ZOMBIE: return None if abs(process.create_time() - st...
68
1,959
ArchiveBox
archivebox/workers/supervisord_util.py
.py
__package__ = "archivebox.workers" import csv import json import os import shlex import shutil import signal import socket import subprocess import sys import time from functools import cache from pathlib import Path from typing import cast from xmlrpc.client import Error as XmlRpcError from xmlrpc.client import Fault...
1,527
58,961
ArchiveBox
archivebox/workers/management/commands/supervisord_watchdog.py
.py
import time import psutil from django.core.management.base import BaseCommand class Command(BaseCommand): help = "Stop a foreground-owned supervisord if its exact ArchiveBox owner Process exits." def add_arguments(self, parser): parser.add_argument("--supervisord-process-id", required=True) ...
73
2,722
ArchiveBox
archivebox/workers/management/commands/runner_watch.py
.py
from django.core.management.base import BaseCommand class Command(BaseCommand): help = "Watch the debug runserver Process row and restart the background runner on autoreloads." def add_arguments(self, parser): parser.add_argument( "--bind-url", default="", help="Ru...
122
4,310
ArchiveBox
archivebox/plugins/apps.py
.py
__package__ = "archivebox.plugins" from django.apps import AppConfig class PluginsConfig(AppConfig): default_auto_field = "django.db.models.BigAutoField" name = "archivebox.plugins" verbose_name = "Plugins"
10
222
ArchiveBox
archivebox/plugins/hooks.py
.py
""" Hook discovery and execution helpers for ArchiveBox plugins. ArchiveBox no longer drives plugin execution itself during normal crawls. `abx-dl` owns the live runtime and emits typed bus events; ArchiveBox mainly: - discovers hook files for inspection / docs / legacy direct execution helpers - executes individual ...
650
24,831
ArchiveBox
archivebox/plugins/discovery.py
.py
__package__ = "archivebox.plugins" import json from collections.abc import Iterable from functools import lru_cache from pathlib import Path from typing import Any, Protocol, TypedDict from abx_plugins import get_plugins_dir from django.utils.safestring import mark_safe from archivebox.config.constants import CONSTA...
320
9,798
ArchiveBox
archivebox/plugins/views.py
.py
__package__ = "archivebox.plugins" import html import json import re from collections.abc import Callable from typing import Any from urllib.parse import quote from admin_data_views.typing import ItemContext, SectionData, TableContext from admin_data_views.utils import ItemLink, render_with_item_view, render_with_tab...
435
16,087
ArchiveBox
archivebox/plugins/forms.py
.py
__package__ = "archivebox.plugins" import json import re from collections.abc import Iterable, Mapping from pathlib import Path from typing import Any from django import forms from django.utils.html import format_html from archivebox.config import CONSTANTS_CONFIG from archivebox.config.common import ArchiveBoxConfi...
612
22,577
ArchiveBox
archivebox/misc/paginators.py
.py
__package__ = "archivebox.misc" from django.core.paginator import Paginator from django.db.models import QuerySet from django.utils.functional import cached_property class AcceleratedPaginator(Paginator): """Paginator that accepts exact count hints for already-optimized query paths.""" @cached_property ...
26
811
ArchiveBox
archivebox/misc/logging.py
.py
__package__ = "archivebox.misc" # Bootable logging primitives (Rich console, ANSI colors, stdout/stderr helpers). # MUST NOT import archivebox.config, archivebox.core, or Django — this module is # loaded via config/constants.py during pre-bootstrap, before settings or apps # are ready. Post-bootstrap CLI logging helpe...
124
4,103
ArchiveBox
archivebox/misc/monkey_patches.py
.py
__package__ = "archivebox" import datetime import re import warnings from daphne import access import django_stubs_ext from django.utils import timezone django_stubs_ext.monkeypatch() # monkey patch django timezone to add back utc (it was removed in Django 5.0) setattr(timezone, "utc", datetime.UTC) # Hide site-...
77
2,861
ArchiveBox
archivebox/misc/toml_util.py
.py
from typing import Any, cast from collections.abc import Callable import json import ast import inspect import toml import re import configparser from pathlib import Path, PosixPath from pydantic.json_schema import GenerateJsonSchema from pydantic_core import to_jsonable_python JSONValue = str | bool | int | None |...
117
3,479
ArchiveBox
archivebox/misc/logging_util.py
.py
__package__ = "archivebox" # Post-bootstrap CLI logging helpers (event loggers, progress bars, formatters). # Requires archivebox.config to be loaded — imports CONSTANTS/get_config and # references Django ORM types. For pre-bootstrap logging primitives use # misc/logging.py, which has no archivebox or Django dependenc...
477
17,831
ArchiveBox
archivebox/misc/util.py
.py
__package__ = "archivebox.misc" # Bootable utility functions (URL parsing, date parsing, JSON encoding, decorators). # MUST NOT import archivebox.config, archivebox.core, or Django — this module is # loaded by hooks.py and other early code paths. Only depends on stdlib and the # bootable .logging module. import re im...
542
17,216
ArchiveBox
archivebox/misc/system.py
.py
__package__ = "archivebox.misc" # Post-bootstrap filesystem utilities (atomic_write, get_dir_size). # Requires archivebox.config (uses get_config for permissions/output settings). # Not safe to import pre-bootstrap. import os from json import dump from pathlib import Path from atomicwrites import atomic_write as li...
80
3,285
ArchiveBox
archivebox/misc/checks.py
.py
__package__ = "archivebox.misc" import os import signal import sys import time import threading from contextlib import contextmanager from pathlib import Path from rich import print from rich.panel import Panel # DO NOT ADD ANY TOP-LEVEL IMPORTS HERE to anything other than builtin python libraries # this file is imp...
404
19,841
ArchiveBox
archivebox/misc/jsonl.py
.py
""" JSONL (JSON Lines) utilities for ArchiveBox. Provides functions for reading, writing, and processing typed JSONL records. All CLI commands that accept stdin can read both plain URLs and typed JSONL. CLI Pipeline: archivebox crawl URL -> {"type": "Crawl", "id": "...", "urls": "...", ...} archivebox snap...
159
4,738
ArchiveBox
archivebox/misc/shell_welcome_message.py
.py
__package__ = "archivebox.core" from rich.console import Console # helpful imports that make the shell easier to work with out-of-the-box: import re # noqa import os # noqa import sys # noqa import json # noqa import psutil # noqa import django # noqa import pydantic # noqa import requests # noqa import subpr...
65
2,903
ArchiveBox
archivebox/misc/hashing.py
.py
# Bootable hashing helpers (file content + mtime/size cache, mime detection). # MUST NOT import archivebox.config, archivebox.core, or Django — stdlib only. import hashlib import mimetypes from functools import lru_cache from pathlib import Path from collections.abc import Callable from datetime import datetime @lru...
261
8,666
ArchiveBox
archivebox/misc/db.py
.py
""" Database utility functions for ArchiveBox. Post-bootstrap: requires archivebox.config constants and uses Django lazily (``from django.db import ...`` inside functions). Not safe to import pre-bootstrap. """ __package__ = "archivebox.misc" from io import StringIO from pathlib import Path from typing import TextIO...
643
28,847
ArchiveBox
archivebox/misc/serve_static.py
.py
import asyncio import html import importlib import json import mimetypes import os import posixpath import queue import re import stat import sys import threading import time import zipfile from collections.abc import Callable from datetime import UTC, datetime from pathlib import Path from urllib.parse import quote, u...
1,176
43,520
ArchiveBox
docs/conf.py
.py
# Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # http://www.sphinx-doc.org/en/master/config # -- Path setup -------------------------------------------------------------- # If extensions (or module...
248
8,356
ArchiveBox
docs/test_codeblocks_manifest.py
.py
"""Inventory, validate, and run the code examples in the authored documentation. The docs stay written for people. This scanner reads Markdown fences and the README's deliberately hand-authored ``<pre lang="bash">`` examples without requiring test directives in the prose. """ from __future__ import annotations impo...
607
26,698
serena
sync.py
.py
import os from repo_dir_sync import LibRepo, OtherRepo r = LibRepo(name="serena", libDirectory="src") r.add(OtherRepo(name="mux", branch="mux", pathToLib=os.path.join("..", "serena-multiplexer", "src-serena"))) r.runMain()
7
224
serena
repo_dir_sync.py
.py
# -*- coding: utf-8 -*- import glob import os import shutil from subprocess import Popen, PIPE import re import sys from typing import List, Optional, Sequence import platform def popen(cmd): shell = platform.system() != "Windows" p = Popen(cmd, shell=shell, stdin=PIPE, stdout=PIPE) return p def call(cm...
364
15,260
serena
docs/autogen_docs.py
.py
import logging import os import re import shutil from pathlib import Path from typing import Optional, List from sensai.util.string import TextBuilder log = logging.getLogger(os.path.basename(__file__)) TOP_LEVEL_PACKAGE = "serena" PROJECT_NAME = "Serena" def module_template(module_qualname: str): module_name =...
250
10,192
serena
docs/create_toc.py
.py
import os from pathlib import Path # This script provides a platform-independent way of making the jupyter-book call (used in pyproject.toml) folder = Path(__file__).parent toc_file = folder / "_toc.yml" cmd = f"jupyter-book toc from-project docs -e .rst -e .md -e .ipynb >{toc_file}" print(cmd) os.system(cmd)
10
312
serena
scripts/gen_prompt_factory.py
.py
""" Autogenerates the `prompt_factory.py` module """ from pathlib import Path from sensai.util import logging from interprompt import autogenerate_prompt_factory_module from serena.constants import PROMPT_TEMPLATES_DIR_INTERNAL, REPO_ROOT log = logging.getLogger(__name__) def main(): autogenerate_prompt_facto...
24
581
serena
scripts/agno_agent.py
.py
from agno.models.anthropic.claude import Claude from agno.models.google.gemini import Gemini from agno.os import AgentOS from sensai.util import logging from sensai.util.helper import mark_used from serena.agno import SerenaAgnoAgentProvider mark_used(Gemini, Claude) # initialize logging if __name__ == "__main__": ...
34
976
serena
scripts/print_tool_overview.py
.py
from serena.agent import ToolRegistry if __name__ == "__main__": ToolRegistry().print_tool_overview()
5
107
serena
scripts/live_test_grok.py
.py
""" Live smoke test for Serena's Grok Build integration. Verifies that the Grok support (``serena setup grok``, the ``grok`` context and the native ``serena-hooks --client=grok`` protocol) works against a *real* ``grok`` CLI installation — exercising the exact code paths that the unit tests cover with mocks (``test/se...
1,195
60,945
serena
scripts/demo_find_defining_symbol.py
.py
""" Demonstrates both defining-symbol tools on the Python test repository. """ import json import re from pathlib import Path from pprint import pprint from serena.agent import SerenaAgent from serena.config.serena_config import LanguageBackend, ProjectConfig, RegisteredProject, SerenaConfig from serena.constants imp...
113
4,294