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

Pon cardstream en marcha

Un solo comando en macOS y Linux; un wheel publicado, un Dockerfile y una compilación desde el código fuente cuando quieras más control. macOS arm64, Linux amd64 y Windows amd64 quedan cubiertos por la misma versión en Python puro.

Script de instalación

Instálalo con un comando

Crea un entorno virtual en ~/.cardstream, verifica el wheel publicado con sus checksums, descarga los pesos de los modelos y pone cardstream-web y cardstream-client en tu PATH. Usa uv si lo tienes instalado.

$ 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 — muestra una carta a la cámara

Ajustes, si los necesitas

  • CARDSTREAM_VERSION — fija una etiqueta de versión en lugar de la última, p. ej. v0.5.0
  • CARDSTREAM_HOME — raíz de la instalación con el entorno virtual y los modelos (por defecto ~/.cardstream)
  • INSTALL_DIR — dónde van los shims cardstream-web / cardstream-client (por defecto ~/.local/bin)
  • CARDSTREAM_MODELS_BASE_URL — host alternativo para los tarballs de pesos de cada modelo
  • CARDSTREAM_MODEL_ARCHIVES — qué tarballs descargar de ahí (separados por espacios)
  • CARDSTREAM_EXTRAS — extras de pip que instalar (por defecto client,onnx)
  • CARDSTREAM_TRACKER_URL — el .onnx opcional de vitTracker (por defecto: el zoo de OpenCV)
Verificar

Verifica la instalación

El script comprueba el wheel contra el SHA256SUMS de la versión antes de instalar nada. Después, un solo flag confirma lo que hay en tu máquina:

$ cardstream-web --version
cardstream 0.5.0

¿Descargaste los artefactos por tu cuenta? Compruébalos igual que lo hace el script: shasum -a 256 -c SHA256SUMS.

Descarga manual

Directamente desde la versión publicada

El paquete está en PyPI, y cada versión de GitHub incluye el mismo wheel y el sdist junto a un SHA256SUMS. Un único wheel en Python puro cubre todas las plataformas:

$ pip install 'cardstream[client,onnx]'

Windows

El script de instalación es solo para POSIX; en Windows instala desde PyPI, descomprime los tarballs de pesos de cada modelo desde la versión de modelos y apunta los flags hacia ellos:

> 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
Comparativa

Elige tu vía

Vía Ideal cuando Primera verificación
Script de instalación Quieres la puesta en marcha más rápida en localhost: entorno virtual, pesos de los modelos y shims en el PATH, todo resuelto por ti. cardstream-web --version
Docker Un host limpio, o recibir el envío de OBS en un equipo cerca del codificador. curl -s http://127.0.0.1:8001/mode
Compilar desde el código Vas a modificar el código. pytest -q tests/core/test_engine.py
Docker

Ejecútalo en un contenedor

La imagen descarga los pesos de los modelos a un volumen en el primer arranque y lanza el cliente web. Constrúyela desde el Dockerfile del repositorio:

$ 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

El contenedor escucha en 0.0.0.0 internamente: publica el puerto solo en 127.0.0.1, como arriba. La aplicación no tiene autenticación y guarda tu clave de API de Ximilar; nunca la expongas a la red local ni a internet.

Código fuente

Compilar desde el código

Un checkout, un script y la suite de pruebas sin conexión como primera verificación. --models descarga también los pesos.

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

Siguientes pasos

Instalar y ejecutar →

Tu clave, tu primera ejecución y qué comprobar.

Pásale tu show →

Webcams, pull por RTSP, envío directo desde OBS.

Opera con confianza →

Umbrales, la configuración recomendada y cómo quedarte en localhost.

Actualizar o desinstalar →

Dónde deja las cosas el script y los dos comandos que lo deshacen.