Download

Metti in funzione cardstream

Un solo comando su macOS e Linux; un wheel di release, un Dockerfile e una build dai sorgenti quando vuoi più controllo. macOS arm64, Linux amd64 e Windows amd64 sono tutti coperti dalla stessa release in puro Python.

Script di installazione

Installa con un solo comando

Crea un virtualenv in ~/.cardstream, verifica il wheel della release con i suoi checksum, scarica i pesi dei modelli e mette cardstream-web e cardstream-client nel tuo PATH. Usa uv, se ce l’hai.

$ 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 (mostra una carta)

Le regolazioni, se ti servono

CARDSTREAM_VERSION — fissa un tag di release invece dell’ultima, ad esempio v0.5.0
CARDSTREAM_HOME — radice dell’installazione, con il venv e i modelli (predefinita ~/.cardstream)
INSTALL_DIR — dove finiscono gli shim cardstream-web / cardstream-client (predefinita ~/.local/bin)
CARDSTREAM_MODELS_BASE_URL — host alternativo per i tarball dei pesi, uno per modello
CARDSTREAM_MODEL_ARCHIVES — quali tarball scaricare da lì (separati da spazi)
CARDSTREAM_EXTRAS — extra di pip da installare (predefiniti client,onnx)
CARDSTREAM_TRACKER_URL — il .onnx opzionale del vitTracker (predefinito: lo zoo di OpenCV)

Verifica

Verifica l’installazione

Lo script verifica il wheel con il file SHA256SUMS della release prima di installare qualsiasi cosa. Dopo, un solo flag conferma che cosa c’è sul tuo computer:

$ cardstream-web --version
cardstream 0.5.0

Hai scaricato gli artefatti per conto tuo? Controllali come fa lo script: shasum -a 256 -c SHA256SUMS.

Download manuale

Direttamente dalla release

Il pacchetto è su PyPI, e ogni release su GitHub contiene lo stesso wheel e lo stesso sdist accanto a un SHA256SUMS. Un solo wheel in puro Python copre tutte le piattaforme:

$ pip install 'cardstream[client,onnx]'

Windows

Lo script di installazione funziona solo su sistemi POSIX; su Windows installa da PyPI, scompatta i tarball dei pesi di ciascun modello dalla release dei modelli e punta i flag su di essi:

> 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

Confronto

Scegli il metodo

Metodo	Ideale quando	Prima verifica
Script di installazione	Vuoi la configurazione più rapida in localhost: venv, pesi dei modelli e shim nel PATH, tutto già sistemato.	`cardstream-web --version`
Docker	Parti da un host pulito, o ricevi un push di OBS su un computer vicino all’encoder.	`curl -s http://127.0.0.1:8001/mode`
Build dai sorgenti	Stai modificando il codice.	`pytest -q tests/core/test_engine.py`

Docker

Fallo girare in un container

Al primo avvio l’immagine scarica i pesi dei modelli in un volume e avvia il client web. Costruiscila dal Dockerfile del repository:

$ 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

Al suo interno il container ascolta su 0.0.0.0: pubblica la porta solo su 127.0.0.1, come qui sopra. L’app non ha autenticazione e custodisce la tua chiave API Ximilar; non esporla mai a una rete locale né a Internet.

Sorgenti

Build dai sorgenti

Un checkout, uno script e la suite di test offline come prima verifica. --models scarica anche i pesi.

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

Metti in funzione cardstream

Installa con un solo comando

Le regolazioni, se ti servono

Verifica l’installazione

Direttamente dalla release

Windows

Scegli il metodo

Fallo girare in un container

Build dai sorgenti

Prossimi passi

Installa e avvia →

Dagli il tuo show →

Usalo con fiducia →

Aggiorna o disinstalla →