Skip to content

Install a client library

Install the WorkManager's client library for your language. What each library offers is in its reference: C#, Python, TypeScript.

C

Add the Virtufin package source with a personal access token (scope: read:packages):

dotnet nuget add source https://nuget.haenerconsulting.com/api/packages/virtufin/nuget/index.json \
  --name Virtufin --username <your-gitea-username> --password <your-gitea-token>

dotnet add package Virtufin.WorkManager.Client

The package carries the generated gRPC stubs (Virtufin.WorkManager.Protos, packed inside) and depends on Virtufin.Worker.Host (the worker contract) and Virtufin.Api.Client (the gateway client). It is NativeAOT-compatible.

Python

From Gitea PyPI Registry

Set up authentication with a Gitea personal access token (scope: read:packages):

export PIP_USERNAME=<your-gitea-username>
export PIP_PASSWORD=<your-gitea-token>

pip install virtufin-workmanager \
  --index-url https://pypi.haenerconsulting.com/api/packages/virtufin/pypi/simple/ \
  --extra-index-url https://pypi.org/simple

From Local Source

pip install grpcio grpcio-reflection
export PYTHONPATH=/path/to/workmanager/src/python

TypeScript

From Gitea npm Registry

Map the @virtufin scope to the registry and add a token (scope: read:package):

cat >> ~/.npmrc <<'EOF'
@virtufin:registry=https://gitea.haenerconsulting.com/api/packages/virtufin/npm/
//gitea.haenerconsulting.com/api/packages/virtufin/npm/:_authToken=<your-gitea-token>
EOF

Use gitea.haenerconsulting.com, not the npm.* alias: Gitea advertises dist.tarball on gitea.* whatever host you query, so the npm.* form fetches metadata authenticated and then follows an unauthenticated redirect for the payload — npm matches tokens by URL prefix.

Then install:

npm install @virtufin/workmanager

From Local Source

{
  "dependencies": {
    "@virtufin/workmanager": "file:path/to/src/typescript"
  }
}