Weevir SDK

Signal-based governance and telemetry connectors (wevr-sdk / @wevr/sdk-js / Wevr.Sdk).

The Weevir platform repo stays private. These packages are published to public registries so anyone with a license key can install and start sending traffic.

Install

# Python 3.9+  — core: Weevir Postgres sink, Postgres/PGVector, REST
pip install wevr-sdk
pip install "wevr-sdk[llm]"     # OpenRouter only (do not install if unused)
pip install "wevr-sdk[mongo]"   # MongoDB only (do not install if unused)

# JavaScript (Node 18+) — REST + OpenRouter use fetch (no extra LLM package)
npm install @wevr/sdk-js
npm install pg                  # only if using WevrPostgresSink

# .NET 8+ — REST + OpenRouter + WevrPostgresSink (Npgsql only)
dotnet add package Wevr.Sdk

Pin a version in production (wevr-sdk==0.5.1, @wevr/sdk-js@0.5.1, Wevr.Sdk 0.5.1).

Startup docs (Python + npm)

Each public package ships developer and coding-agent briefs. Print them after install:

# Python
wevr-advise start      # developers
wevr-advise agents     # coding agents

# JavaScript
npx wevr-advise start
npx wevr-advise agents

Requirements

• A Weevir license key (wk_…) for your organization — see Get your license key
• Weevir governance Postgres (WEVR_PG_*)
• Environment name + type on every process (no dashboard registration step)

Quick verify

import wevr
print(wevr.__version__)

import { EnvironmentType } from '@wevr/sdk-js';
console.log(EnvironmentType.PROD);

using Wevr.Sdk;
Console.WriteLine(WevrEnvironmentResolver.DeploymentKey("billing-api", EnvironmentType.PROD));

Connectors

All consumer connectors emit telemetry through Weevir Postgres (WEVR_PG_*) and need your license key as tenant_id.

Initialise Weevir (required)

Missing name or type → connector init fails (no silent default).

import os
from wevr.connect.storage.postgres import WevrPostgresConnector
from wevr.connect.http.rest import RestApiConnector

wevr_pg = WevrPostgresConnector(tenant_id=os.getenv("WEVR_LICENSE_KEY"))
wevr_pg.connect()
rest = RestApiConnector(
    tenant_id=os.getenv("WEVR_LICENSE_KEY"),
    wevr_pg=wevr_pg,
    environment_name=os.getenv("WEVR_ENVIRONMENT_NAME"),
    environment_type=os.getenv("WEVR_ENVIRONMENT_TYPE"),
)
rest.connect()

import { RestApiConnector, WevrPostgresSink } from '@wevr/sdk-js';

const wevrPg = new WevrPostgresSink({ tenantId: process.env.WEVR_LICENSE_KEY });
const rest = new RestApiConnector({
  tenantId: process.env.WEVR_LICENSE_KEY,
  wevrPg,
  environment: {
    name: process.env.WEVR_ENVIRONMENT_NAME,
    type: process.env.WEVR_ENVIRONMENT_TYPE,
  },
});
await rest.connect();

using Wevr.Sdk;

await using var wevrPg = new WevrPostgresSink(new WevrPostgresSinkOptions
{
    TenantId = Environment.GetEnvironmentVariable("WEVR_LICENSE_KEY"),
});
await using var rest = new RestApiConnector(new RestApiConnectorOptions
{
    TenantId = Environment.GetEnvironmentVariable("WEVR_LICENSE_KEY"),
    WeevirPg = wevrPg,
    EnvironmentName = Environment.GetEnvironmentVariable("WEVR_ENVIRONMENT_NAME"),
    EnvironmentType = Environment.GetEnvironmentVariable("WEVR_ENVIRONMENT_TYPE"),
});
await rest.ConnectAsync();

How environments appear

1. Install the package on a host / container / region
2. Set the same org WEVR_LICENSE_KEY
3. Set a unique pair: name + type for that install
4. Run traffic — envelopes land under org_id with deployment key {name}/{type}
5. Refresh the dashboard — the environment appears under filters, Environments, Settings, and live metrics

Runtime environment variables

Get your license key

1. Log in to the Weevir dashboard
2. Open Settings — the license key is shown on the org card as WEVR_LICENSE / license_key
3. Store it as WEVR_LICENSE_KEY (env var / secrets manager). Do not put wk_… in dashboard tenantId query params — the API expects the resolved org_id UUID there.

Signup also returns org.license_key. One license key = one organization.

Package layout

Local development (contributors)

From this folder (Weevir.SDK):

pip install -e ".[llm,mongo,test]"
cd js && npm test
dotnet test dotnet/Wevr.Sdk.Tests/Wevr.Sdk.Tests.csproj

Maintainers: publish

Platform source stays in the private GitHub repo. CI publishes only these three packages when you push a tag sdk-vX.Y.Z (for example sdk-v0.5.1).

One-time registry setup

1. PyPI — create the project wevr-sdk (or confirm the name is free). Add GitHub secret PYPI_API_TOKEN (Trusted Publishing is preferred).
2. npm — create the @wevr org (or change the package name in js/package.json). Add GitHub secret NPM_TOKEN with publish rights. Scoped packages need "publishConfig.access": "public" (already set).
3. NuGet — create Wevr.Sdk on nuget.org. Add GitHub secret NUGET_API_KEY.
4. Confirm GitHub Actions can run on this private repo (Actions enabled).

Release

1. Bump versions in pyproject.toml, src/wevr/__init__.py, js/package.json, and dotnet/Directory.Build.props so they match the tag.
2. git tag sdk-v0.5.1 && git push origin sdk-v0.5.1
3. Workflow .github/workflows/publish-sdk.yml tests, then publishes to PyPI, npm, and NuGet.

Customers never need GitHub access. Runtime access is still gated by wk_….