kodit 0.2.2__tar.gz → 0.2.3__tar.gz

{kodit-0.2.2 → kodit-0.2.3}/Dockerfile

@@ -1,5 +1,6 @@
 # syntax=docker/dockerfile:1.9
-FROM python:3.13.4-slim-bookworm AS build
+ARG PYTHON_VERSION=3.13.5
+FROM python:${PYTHON_VERSION}-slim-bookworm AS build
 
 # The following does not work in Podman unless you build in Docker
 # compatibility mode: <https://github.com/containers/podman/issues/8477>
@@ -60,7 +61,7 @@ RUN --mount=type=cache,target=/root/.cache/uv \
 
 ##########################################################################
 
-FROM python:3.13.4-slim-bookworm
+FROM python:${PYTHON_VERSION}-slim-bookworm
 SHELL ["sh", "-exc"]
 
 RUN <<EOT

{kodit-0.2.2 → kodit-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kodit
-Version: 0.2.2
+Version: 0.2.3
 Summary: Code indexing for better AI code generation
 Project-URL: Homepage, https://docs.helixml.tech/kodit/
 Project-URL: Documentation, https://docs.helixml.tech/kodit/
@@ -37,9 +37,9 @@ Requires-Dist: httpx-retries>=0.3.2
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: openai>=1.82.0
 Requires-Dist: pathspec>=0.12.1
-Requires-Dist: posthog>=4.0.1
 Requires-Dist: pydantic-settings>=2.9.1
 Requires-Dist: pytable-formatter>=0.1.1
+Requires-Dist: rudder-sdk-python>=2.1.4
 Requires-Dist: sentence-transformers>=4.1.0
 Requires-Dist: sqlalchemy[asyncio]>=2.0.40
 Requires-Dist: structlog>=25.3.0

{kodit-0.2.2 → kodit-0.2.3}/docs/_index.md

@@ -90,7 +90,7 @@ The roadmap is currently maintained as a [Github Project](https://github.com/org
 
 ## 💬 Support
 
-For commercial support, please contact [Helix.ML](founders@helix.ml). To ask a question,
+For commercial support, please contact [Helix.ML](https://docs.helixml.tech/helix/help/). To ask a question,
 please [open a discussion](https://github.com/helixml/kodit/discussions).
 
 ## License

{kodit-0.2.2 → kodit-0.2.3}/docs/developer/index.md

@@ -11,10 +11,11 @@ All database operations are handled by SQLAlchemy and Alembic.
 ### Creating a Database Migration
 
 1. Make changes to your models
-2. Ensure the model is referenced in [alembic's env.py](src/kodit/alembic/env.py)
-3. Run `alembic upgrade head` to create a temporary DB to compute the upgrade
-4. Run `alembic revision --autogenerate -m "your message"`
-5. The new migration will be applied when you next run a kodit command
+2. Ensure the model is referenced in [alembic's env.py](https://github.com/helixml/kodit/blob/main/src/kodit/migrations/env.py)
+3. Remove the temporary DB if it exists from a previous migration: `rm -f .kodit.db`
+4. Run `alembic upgrade head` to create a temporary DB to compute the upgrade
+5. Run `alembic revision --autogenerate -m "your message"`
+6. The new migration will be applied when you next run a kodit command
 
 ## Releasing
 

kodit-0.2.3/docs/reference/deployment/docker-compose.yaml

@@ -0,0 +1,40 @@
+version: "3.9"
+
+services:
+  kodit:
+    image: registry.helix.ml/helix/kodit:latest # Replace with a version
+    ports:
+      - "8080:8080" # Expose the MCP server
+    # Start the Kodit MCP server and bind to all interfaces
+    command: ["serve", "--host", "0.0.0.0", "--port", "8080"]
+    restart: unless-stopped
+    depends_on:
+      - vectorchord # Wait for VectorChord to start before Kodit
+    
+    # Configure Kodit
+    environment:
+      # Configure the database
+      DB_URL: postgresql+asyncpg://postgres:mysecretpassword@vectorchord:5432/kodit
+      DEFAULT_SEARCH_PROVIDER: vectorchord
+
+      # External embedding provider
+      EMBEDDING_ENDPOINT_TYPE: openai
+      EMBEDDING_ENDPOINT_BASE_URL: https://api.openai.com/v1
+      EMBEDDING_ENDPOINT_API_KEY: REPLACE_WITH_YOUR_API_KEY
+      EMBEDDING_ENDPOINT_MODEL: text-embedding-3-large
+
+      # External enrichment provider
+      ENRICHMENT_ENDPOINT_TYPE: openai
+      ENRICHMENT_ENDPOINT_BASE_URL: https://api.openai.com/v1
+      ENRICHMENT_ENDPOINT_API_KEY: REPLACE_WITH_YOUR_API_KEY
+      ENRICHMENT_ENDPOINT_MODEL: o3-mini
+
+
+  vectorchord:
+    image: tensorchord/vchord-suite:pg17-20250601
+    environment:
+      - POSTGRES_DB=kodit
+      - POSTGRES_PASSWORD=mysecretpassword
+    ports:
+      - "5432:5432"
+    restart: unless-stopped

kodit-0.2.3/docs/reference/deployment/index.md

@@ -0,0 +1,35 @@
+---
+title: Deployment
+description: Deploying Kodit with Docker Compose and Kubernetes.
+weight: 10
+---
+
+Kodit is packaged as a Docker container so you can run it on any popular orchestration platform. This page describes how to deploy Kodit as a service.
+
+## Deploying With Docker Compose
+
+Create a [docker-compose file](https://github.com/helixml/kodit/tree/main/docs/reference/deployment/docker-compose.yaml) that specifies Kodit and Vectorchord containers. Replace the latest tag with a version. Replace any API keys with your own or configure internal endpoints.
+
+Then run Kodit with `docker compose -f docker-compose.yaml up -d`. For more instructions see the [Docker Compose documentation](https://docs.docker.com/compose/).
+
+Here is an example:
+
+{{< code file="docker-compose.yaml" >}}
+
+## Deploying With Kubernetes
+
+To deploy with Kubernetes we recommend using a templating solution like Helm or Kustomize.
+
+Here is a simple [raw Kubernetes manifest](https://github.com/helixml/kodit/tree/main/docs/reference/deployment/kubernetes.yaml) to help get you started. Remember to pin the Kodit container at a specific version and update the required API keys.
+
+Deploy with `kubectl -n kodit apply -f kubernetes.yaml`
+
+{{< code file="kubernetes.yaml" >}}
+
+### Deploying With a Kind Kubernetes Cluster
+
+[Kind](https://kind.sigs.k8s.io/) is a k8s cluster that runs in a Docker container. So it's great for k8s development.
+
+1. `kind create cluster`
+2. `kubectl -n kodit apply -f kubernetes.yaml`
+

kodit-0.2.3/docs/reference/deployment/kubernetes.yaml

@@ -0,0 +1,99 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: vectorchord
+  labels:
+    app: vectorchord
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: vectorchord
+  template:
+    metadata:
+      labels:
+        app: vectorchord
+    spec:
+      containers:
+        - name: vectorchord
+          image: tensorchord/vchord-suite:pg17-20250601
+          env:
+            - name: POSTGRES_DB
+              value: "kodit"
+            - name: POSTGRES_PASSWORD
+              value: "mysecretpassword"
+          ports:
+            - containerPort: 5432
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: vectorchord
+spec:
+  selector:
+    app: vectorchord
+  ports:
+    - port: 5432
+      targetPort: 5432
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: kodit
+  labels:
+    app: kodit
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: kodit
+  template:
+    metadata:
+      labels:
+        app: kodit
+    spec:
+      containers:
+        - name: kodit
+          image: registry.helix.ml/helix/kodit:latest # Replace with a version
+          args: ["serve", "--host", "0.0.0.0", "--port", "8080"]
+          env:
+            - name: DB_URL
+              value: "postgresql+asyncpg://postgres:mysecretpassword@vectorchord:5432/kodit"
+            - name: DEFAULT_SEARCH_PROVIDER
+              value: "vectorchord"
+            - name: EMBEDDING_ENDPOINT_TYPE
+              value: "openai"
+            - name: EMBEDDING_ENDPOINT_BASE_URL
+              value: "https://api.openai.com/v1"
+            - name: EMBEDDING_ENDPOINT_API_KEY
+              value: "REPLACE_WITH_YOUR_API_KEY"
+            - name: EMBEDDING_ENDPOINT_MODEL
+              value: "text-embedding-3-large"
+            - name: ENRICHMENT_ENDPOINT_TYPE
+              value: "openai"
+            - name: ENRICHMENT_ENDPOINT_BASE_URL
+              value: "https://api.openai.com/v1"
+            - name: ENRICHMENT_ENDPOINT_API_KEY
+              value: "REPLACE_WITH_YOUR_API_KEY"
+            - name: ENRICHMENT_ENDPOINT_MODEL
+              value: "o3-mini"
+          ports:
+            - containerPort: 8080
+          readinessProbe:
+            httpGet:
+              path: /
+              port: 8080
+            initialDelaySeconds: 10
+            periodSeconds: 5
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: kodit
+spec:
+  type: LoadBalancer
+  selector:
+    app: kodit
+  ports:
+    - port: 8080
+      targetPort: 8080

kodit-0.2.3/docs/reference/telemetry/index.md

@@ -0,0 +1,31 @@
+---
+title: Telemetry
+description: Learn about what data is collected and how to disable it.
+weight: 99
+---
+
+Kodit includes a very limited amount anonymous telemetry to help guide product
+development. At the moment Kodit uses [Rudderstack](https://rudderstack.com) to capture
+anonymous usage metrics.
+
+## What Kodit Captures
+
+You can see what metrics are sent by searching for [use of the helper
+functions](https://github.com/helixml/kodit/blob/main/src/kodit/log.py#L169) in the Kodit
+codebase.
+
+Kodit currently captures use of the following:
+
+- When a user uses the CLI methods
+- When the indexing service is used or queried
+
+No user data is collected, only metadata about Kodit usage.
+
+## Disabling Telemetry
+
+We hope that you will help us improve Kodit by leaving telemetry turned on, but if you'd
+like to turn it off, add the following environmental variable (or add it to your .env file):
+
+```sh
+DISABLE_TELEMETRY=true
+```

{kodit-0.2.2 → kodit-0.2.3}/pyproject.toml

@@ -31,7 +31,6 @@ dependencies = [
     "httpx-retries>=0.3.2",
     "httpx>=0.28.1",
     "structlog>=25.3.0",
-    "posthog>=4.0.1",
     "sqlalchemy[asyncio]>=2.0.40",
     "alembic>=1.15.2",
     "aiosqlite>=0.20.0",
@@ -53,6 +52,7 @@ dependencies = [
     "asyncpg>=0.30.0",
     "transformers>=4.51.3",
     "accelerate>=1.7.0",
+    "rudder-sdk-python>=2.1.4",
 ]
 
 [dependency-groups]

{kodit-0.2.2 → kodit-0.2.3}/src/kodit/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.2'
-__version_tuple__ = version_tuple = (0, 2, 2)
+__version__ = version = '0.2.3'
+__version_tuple__ = version_tuple = (0, 2, 3)

{kodit-0.2.2 → kodit-0.2.3}/src/kodit/app.py

@@ -21,6 +21,12 @@ async def root() -> dict[str, str]:
     return {"message": "Hello, World!"}
 
 
+@app.get("/healthz")
+async def healthz() -> dict[str, str]:
+    """Return a health check for the kodit API."""
+    return {"status": "ok"}
+
+
 # Add mcp routes last, otherwise previous routes aren't added
 app.mount("", mcp_app)
 

{kodit-0.2.2 → kodit-0.2.3}/src/kodit/cli.py

@@ -81,6 +81,7 @@ async def index(
     )
 
     if not sources:
+        log_event("kodit.cli.index.list")
         # No source specified, list all indexes
         indexes = await service.list_indexes()
         headers: list[str | Cell] = [
@@ -108,7 +109,8 @@ async def index(
             msg = "File indexing is not implemented yet"
             raise click.UsageError(msg)
 
-        # Index directory
+        # Index source
+        log_event("kodit.cli.index.create")
         s = await source_service.create(source)
         index = await service.create(s.id)
         await service.run(index.id)
@@ -134,6 +136,7 @@ async def code(
 
     This works best if your query is code.
     """
+    log_event("kodit.cli.search.code")
     source_repository = SourceRepository(session)
     source_service = SourceService(app_context.get_clone_dir(), source_repository)
     repository = IndexRepository(session)
@@ -177,6 +180,7 @@ async def keyword(
     top_k: int,
 ) -> None:
     """Search for snippets using keyword search."""
+    log_event("kodit.cli.search.keyword")
     source_repository = SourceRepository(session)
     source_service = SourceService(app_context.get_clone_dir(), source_repository)
     repository = IndexRepository(session)
@@ -223,6 +227,7 @@ async def text(
 
     This works best if your query is text.
     """
+    log_event("kodit.cli.search.text")
     source_repository = SourceRepository(session)
     source_service = SourceService(app_context.get_clone_dir(), source_repository)
     repository = IndexRepository(session)
@@ -270,6 +275,7 @@ async def hybrid(  # noqa: PLR0913
     text: str,
 ) -> None:
     """Search for snippets using hybrid search."""
+    log_event("kodit.cli.search.hybrid")
     source_repository = SourceRepository(session)
     source_service = SourceService(app_context.get_clone_dir(), source_repository)
     repository = IndexRepository(session)
@@ -321,7 +327,7 @@ def serve(
     """Start the kodit server, which hosts the MCP server and the kodit API."""
     log = structlog.get_logger(__name__)
     log.info("Starting kodit server", host=host, port=port)
-    log_event("kodit_server_started")
+    log_event("kodit.cli.serve")
 
     # Configure uvicorn with graceful shutdown
     config = uvicorn.Config(

{kodit-0.2.2 → kodit-0.2.3}/src/kodit/embedding/embedding_factory.py

@@ -19,6 +19,7 @@ from kodit.embedding.vectorchord_vector_search_service import (
     TaskName,
     VectorChordVectorSearchService,
 )
+from kodit.log import log_event
 
 
 def _get_endpoint_configuration(app_context: AppContext) -> Endpoint | None:
@@ -34,6 +35,7 @@ def embedding_factory(
     endpoint = _get_endpoint_configuration(app_context)
 
     if endpoint and endpoint.type == "openai":
+        log_event("kodit.embedding", {"provider": "openai"})
         from openai import AsyncOpenAI
 
         embedding_provider = OpenAIEmbeddingProvider(
@@ -44,11 +46,14 @@ def embedding_factory(
             model_name=endpoint.model or "text-embedding-3-small",
         )
     else:
+        log_event("kodit.embedding", {"provider": "local"})
         embedding_provider = LocalEmbeddingProvider(CODE)
 
     if app_context.default_search.provider == "vectorchord":
+        log_event("kodit.database", {"provider": "vectorchord"})
         return VectorChordVectorSearchService(task_name, session, embedding_provider)
     if app_context.default_search.provider == "sqlite":
+        log_event("kodit.database", {"provider": "sqlite"})
         return LocalVectorSearchService(
             embedding_repository=embedding_repository,
             embedding_provider=embedding_provider,

{kodit-0.2.2 → kodit-0.2.3}/src/kodit/embedding/embedding_provider/embedding_provider.py

@@ -39,14 +39,14 @@ def split_sub_batches(
 
         while data_to_process:
             next_item = data_to_process[0]
-            item_tokens = len(encoding.encode(next_item))
+            item_tokens = len(encoding.encode(next_item, disallowed_special=()))
 
             if item_tokens > max_context_window:
                 # Loop around trying to truncate the snippet until it fits in the max
                 # embedding size
                 while item_tokens > max_context_window:
                     next_item = next_item[:-1]
-                    item_tokens = len(encoding.encode(next_item))
+                    item_tokens = len(encoding.encode(next_item, disallowed_special=()))
 
                 data_to_process[0] = next_item
 

{kodit-0.2.2 → kodit-0.2.3}/src/kodit/enrichment/enrichment_factory.py

@@ -11,6 +11,7 @@ from kodit.enrichment.enrichment_service import (
     EnrichmentService,
     LLMEnrichmentService,
 )
+from kodit.log import log_event
 
 
 def _get_endpoint_configuration(app_context: AppContext) -> Endpoint | None:
@@ -24,6 +25,7 @@ def enrichment_factory(app_context: AppContext) -> EnrichmentService:
     endpoint = app_context.enrichment_endpoint or app_context.default_endpoint or None
 
     if endpoint and endpoint.type == "openai":
+        log_event("kodit.enrichment", {"provider": "openai"})
         from openai import AsyncOpenAI
 
         enrichment_provider = OpenAIEnrichmentProvider(
@@ -34,6 +36,7 @@ def enrichment_factory(app_context: AppContext) -> EnrichmentService:
             model_name=endpoint.model or "gpt-4o-mini",
         )
     else:
+        log_event("kodit.enrichment", {"provider": "local"})
         enrichment_provider = LocalEnrichmentProvider()
 
     return LLMEnrichmentService(enrichment_provider=enrichment_provider)

{kodit-0.2.2 → kodit-0.2.3}/src/kodit/indexing/indexing_service.py

@@ -26,6 +26,7 @@ from kodit.enrichment.enrichment_service import EnrichmentService
 from kodit.indexing.fusion import FusionRequest, reciprocal_rank_fusion
 from kodit.indexing.indexing_models import Snippet
 from kodit.indexing.indexing_repository import IndexRepository
+from kodit.log import log_event
 from kodit.snippets.snippets import SnippetService
 from kodit.source.source_service import SourceService
 from kodit.util.spinner import Spinner
@@ -45,7 +46,7 @@ class IndexView(pydantic.BaseModel):
     created_at: datetime
     updated_at: datetime | None = None
     source: str | None = None
-    num_snippets: int | None = None
+    num_snippets: int
 
 
 class SearchRequest(pydantic.BaseModel):
@@ -119,6 +120,8 @@ class IndexService:
             ValueError: If the source doesn't exist or already has an index.
 
         """
+        log_event("kodit.index.create")
+
         # Check if the source exists
         source = await self.source_service.get(source_id)
 
@@ -129,6 +132,8 @@ class IndexService:
         return IndexView(
             id=index.id,
             created_at=index.created_at,
+            num_snippets=await self.repository.num_snippets_for_index(index.id),
+            source=source.uri,
         )
 
     async def list_indexes(self) -> list[IndexView]:
@@ -142,19 +147,33 @@ class IndexService:
         indexes = await self.repository.list_indexes()
 
         # Transform database results into DTOs
-        return [
+        indexes = [
             IndexView(
                 id=index.id,
                 created_at=index.created_at,
                 updated_at=index.updated_at,
-                num_snippets=await self.repository.num_snippets_for_index(index.id),
+                num_snippets=await self.repository.num_snippets_for_index(index.id)
+                or 0,
                 source=source.uri,
             )
             for index, source in indexes
         ]
 
+        # Help Kodit by measuring how much people are using indexes
+        log_event(
+            "kodit.index.list",
+            {
+                "num_indexes": len(indexes),
+                "num_snippets": sum([index.num_snippets for index in indexes]),
+            },
+        )
+
+        return indexes
+
     async def run(self, index_id: int) -> None:
         """Run the indexing process for a specific index."""
+        log_event("kodit.index.run")
+
         # Get and validate index
         index = await self.repository.get_by_id(index_id)
         if not index:
@@ -218,6 +237,8 @@ class IndexService:
 
     async def search(self, request: SearchRequest) -> list[SearchResult]:
         """Search for relevant data."""
+        log_event("kodit.index.search")
+
         fusion_list: list[list[FusionRequest]] = []
         if request.keywords:
             # Gather results for each keyword