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

Mettre cardstream en route

Une seule commande sur macOS et Linux ; un wheel de release, un Dockerfile et une compilation depuis les sources si vous voulez garder la main. macOS arm64, Linux amd64 et Windows amd64 sont tous couverts par la même release en pur Python.

Script d’installation

Installer en une commande

Crée un virtualenv dans ~/.cardstream, vérifie le wheel de la release avec ses sommes de contrôle, télécharge les poids des modèles et place cardstream-web et cardstream-client dans votre PATH. Utilise uv s’il est installé.

$ 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 — montrez une carte

Les réglages, si vous en avez besoin

  • CARDSTREAM_VERSION — fixe un tag de release au lieu de la dernière, par exemple v0.5.0
  • CARDSTREAM_HOME — racine de l’installation, qui contient le venv et les modèles (par défaut ~/.cardstream)
  • INSTALL_DIR — emplacement des shims cardstream-web / cardstream-client (par défaut ~/.local/bin)
  • CARDSTREAM_MODELS_BASE_URL — autre hôte pour les archives de poids, une par modèle
  • CARDSTREAM_MODEL_ARCHIVES — archives à y récupérer (séparées par des espaces)
  • CARDSTREAM_EXTRAS — extras pip à installer (par défaut client,onnx)
  • CARDSTREAM_TRACKER_URL — le .onnx du vitTracker, optionnel (par défaut : le zoo d’OpenCV)
Vérifier

Vérifier l’installation

Le script vérifie le wheel avec le fichier SHA256SUMS de la release avant d’installer quoi que ce soit. Ensuite, une seule option confirme ce qui se trouve sur votre machine :

$ cardstream-web --version
cardstream 0.5.0

Vous avez téléchargé les artefacts vous-même ? Vérifiez-les comme le fait le script : shasum -a 256 -c SHA256SUMS.

Téléchargement manuel

Directement depuis la release

Le paquet est sur PyPI, et chaque release GitHub contient le même wheel et le même sdist, accompagnés d’un SHA256SUMS. Un seul wheel en pur Python couvre toutes les plateformes :

$ pip install 'cardstream[client,onnx]'

Windows

Le script d’installation ne fonctionne que sur les systèmes POSIX. Sous Windows, installez depuis PyPI, décompressez les archives de poids de chaque modèle fournies avec la release des modèles et pointez les options dessus :

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

Choisir sa méthode

Méthode Idéale quand Première vérification
Script d’installation Vous voulez l’installation en localhost la plus rapide : venv, poids des modèles et shims dans le PATH, tout est fait pour vous. cardstream-web --version
Docker Vous partez d’un hôte vierge, ou vous recevez un push OBS sur une machine proche de l’encodeur. curl -s http://127.0.0.1:8001/mode
Compiler depuis les sources Vous modifiez le code. pytest -q tests/core/test_engine.py
Docker

Le lancer dans un conteneur

Au premier lancement, l’image télécharge les poids des modèles dans un volume, puis démarre le client web. Construisez-la à partir du Dockerfile du dépôt :

$ 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

Le conteneur écoute sur 0.0.0.0 en interne : publiez le port sur 127.0.0.1 uniquement, comme ci-dessus. L’application n’a pas d’authentification et détient votre clé API Ximilar ; ne l’exposez jamais à un réseau local ni à Internet.

Sources

Compiler depuis les sources

Un clone du dépôt, un script, et la suite de tests hors ligne comme première vérification. --models télécharge aussi les poids.

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

Et ensuite

Installer et lancer →

Votre clé, votre premier lancement et ce qu’il faut vérifier.

Lui donner votre show →

Webcams, flux RTSP en pull, OBS qui pousse directement dedans.

L’exploiter en confiance →

Les seuils, la configuration recommandée et pourquoi rester en localhost.

Mettre à jour ou désinstaller →

Où le script range les choses, et les deux commandes qui défont tout.