cardstream
GitHub Aan de slag
Taal: Nederlands
English Español 日本語 한국어 简体中文 ไทย Português Français Italiano Deutsch हिन्दी বাংলা پنجابی Dansk Svenska Polski Русский اردو العربية Tiếng Việt Türkçe Nederlands Bahasa Indonesia
Download

Krijg cardstream aan de praat

Eén commando op macOS en Linux; een release-wheel, een Dockerfile en een build vanaf de broncode als je meer controle wilt. macOS arm64, Linux amd64 en Windows amd64 vallen allemaal onder dezelfde pure-Python-release.

Installatiescript

Installeren met één commando

Maakt een virtualenv aan in ~/.cardstream, controleert de release-wheel aan de hand van de checksums, haalt de modelgewichten op en zet cardstream-web en cardstream-client in je PATH. Gebruikt uv als je dat hebt.

$ curl -fsSL https://raw.githubusercontent.com/Ximilar-com/cardstream/main/scripts/install.sh | sh
$ export XIMILAR_API_KEY=your-key
$ cardstream-web
# → http://127.0.0.1:8001 — houd een kaart omhoog

Instellingen, als je ze nodig hebt

  • CARDSTREAM_VERSION — een vaste release-tag in plaats van de nieuwste, bijv. v0.5.0
  • CARDSTREAM_HOME — installatiemap met de venv en de modellen (standaard ~/.cardstream)
  • INSTALL_DIR — waar de shims cardstream-web / cardstream-client komen (standaard ~/.local/bin)
  • CARDSTREAM_MODELS_BASE_URL — alternatieve host voor de tarballs met gewichten per model
  • CARDSTREAM_MODEL_ARCHIVES — welke tarballs daar worden opgehaald (gescheiden door spaties)
  • CARDSTREAM_EXTRAS — de pip-extras die worden geïnstalleerd (standaard client,onnx)
  • CARDSTREAM_TRACKER_URL — de optionele vitTracker-.onnx (standaard: de OpenCV-zoo)
Controleren

Controleer de installatie

Het script controleert de wheel aan de hand van de SHA256SUMS van de release voordat het iets installeert. Daarna bevestigt één flag wat er op je machine staat:

$ cardstream-web --version
cardstream 0.5.0

Heb je de artefacten zelf gedownload? Controleer ze dan op dezelfde manier als het script: shasum -a 256 -c SHA256SUMS.

Handmatig downloaden

Rechtstreeks van de release

Het pakket staat op PyPI, en elke GitHub-release bevat dezelfde wheel en sdist naast een SHA256SUMS. Eén pure-Python-wheel dekt elk platform:

$ pip install 'cardstream[client,onnx]'

Windows

Het installatiescript werkt alleen op POSIX. Installeer op Windows vanaf PyPI, pak de tarballs met gewichten per model uit de modellenrelease uit en laat de flags ernaar wijzen:

> py -3.11 -m venv cardstream-env
> cardstream-env\Scripts\activate
> pip install 'cardstream[client,onnx]'
> set XIMILAR_API_KEY=your-key
> cardstream-web --segmentor-model models\segmentation_model\onnx\model.onnx ^
    --embed-model models\similarity_model\onnx\model.onnx
Vergelijken

Kies je manier

Manier Het beste wanneer Eerste controle
Installatiescript Je wilt de snelste opzet op localhost: venv, modelgewichten en PATH-shims worden voor je geregeld. cardstream-web --version
Docker Je wilt een schone host, of een push van OBS ontvangen op een machine vlak bij de encoder. curl -s http://127.0.0.1:8001/mode
Bouwen vanaf de broncode Je past de code aan. pytest -q tests/core/test_engine.py
Docker

Draai het in een container

De image haalt bij de eerste start de modelgewichten op in een volume en start de webclient. Bouw hem met de Dockerfile uit de repo:

$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream
$ docker build -t cardstream .
$ docker run --rm -e XIMILAR_API_KEY -p 127.0.0.1:8001:8001 \
    -v cardstream-models:/models cardstream

De container bindt intern aan 0.0.0.0: publiceer de poort alleen op 127.0.0.1, zoals hierboven. De app heeft geen authenticatie en bevat je Ximilar-API-sleutel; stel hem nooit open voor een LAN of het internet.

Broncode

Bouwen vanaf de broncode

Een checkout, één script, en de offline testsuite als eerste controle. Met --models worden ook de gewichten opgehaald.

$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream
$ ./scripts/build-from-source.sh --models
$ source .venv/bin/activate
$ cardstream-web --version

Volgende stappen

Installeren en starten →

Je sleutel, je eerste start en wat je moet controleren.

Geef het je show →

Webcams, ophalen via RTSP, OBS dat er rechtstreeks in pusht.

Met vertrouwen draaien →

Drempels, de aanbevolen configuratie en op localhost blijven.

Bijwerken of verwijderen →

Waar het script alles neerzet, en de twee commando’s die het ongedaan maken.