Skip to content

Installation

Python

From PyPI (when published)

pip install harbour-credentials

From Source (development)

Requires uv and just on your PATH (plus Node.js 22 with Corepack for the TypeScript recipes):

git clone https://github.com/reachhaven/harbour-credentials.git
cd harbour-credentials

# Set up the full dev environment: flat submodules + uv sync (deps, LinkML fork,
# omb from PyPI) + pre-commit hooks + TypeScript deps.
just setup

just recipes run through uv run, which creates and syncs an isolated .venv from uv.lock on demand — no manual venv creation or activation is needed. Use just install-dev to re-sync only the Python environment. Activate the venv only for direct python/pip commands:

# PowerShell
.\.venv\Scripts\Activate.ps1

# macOS / Linux / Git Bash
source .venv/bin/activate

TypeScript

From npm (when published)

npm install @reachhaven/harbour-credentials

From Source

git clone https://github.com/reachhaven/harbour-credentials.git
cd harbour-credentials/src/typescript/harbour

corepack yarn install
corepack yarn build

Verify Installation

Python:

python -m harbour.keys --help
just test

TypeScript:

npm test

Dependencies

Python

  • cryptography — Cryptographic primitives
  • joserfc — JOSE/JWT implementation
  • sd-jwt — SD-JWT implementation

TypeScript

  • jose — JOSE/JWT implementation
  • @sd-jwt/core — SD-JWT implementation