cardstream 0.2.0__tar.gz

cardstream-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ximilar s.r.o.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cardstream-0.2.0/MANIFEST.in

@@ -0,0 +1,14 @@
+# The sdist is what `pip install cardstream` builds from — it needs the
+# package, its metadata and its licence, and nothing else. Without this,
+# setuptools' defaults sweep in a stray top-level test file but not the rest
+# of the suite, which is the worst of both: run the tests from a checkout.
+include LICENSE NOTICE README.md
+recursive-include src/cardstream/webui *
+prune tests
+prune docs
+prune model
+prune scripts
+prune docker
+prune .github
+exclude Makefile Dockerfile uv.lock .pre-commit-config.yaml .editorconfig
+exclude CLAUDE.md AGENTS.md CONTRIBUTING.md SECURITY.md CHANGELOG.md

cardstream-0.2.0/NOTICE

@@ -0,0 +1,46 @@
+cardstream
+Copyright 2026 Ximilar s.r.o.
+
+This product includes software developed at Ximilar (https://ximilar.com).
+
+Licensed under the Apache License, Version 2.0. See LICENSE for the full
+terms.
+
+--------------------------------------------------------------------------
+Third-party components
+--------------------------------------------------------------------------
+
+Every model architecture and runtime weight this project loads is
+Apache-2.0. A licence-encumbered backend is deliberately out of scope --
+see model/README.md.
+
+RF-DETR
+  Roboflow. Apache License 2.0.
+  https://github.com/roboflow/rf-detr
+  The detection and instance-segmentation architectures behind
+  --detector-model and --segmentor-model, finetuned by Ximilar. The
+  finetuned WEIGHTS are a separate grant from the architecture -- see the
+  model zoo for the licence attached to each file.
+
+RT-DETRv2
+  Baidu / lyuwenyu, and the Hugging Face Transformers implementation.
+  Apache License 2.0.
+  https://github.com/lyuwenyu/RT-DETR
+  https://github.com/huggingface/transformers
+  The alternative detection backend (--detector rtdetr).
+
+OpenCV and the OpenCV Model Zoo (vitTracker)
+  OpenCV team. Apache License 2.0.
+  https://github.com/opencv/opencv
+  https://github.com/opencv/opencv_zoo
+  Image primitives throughout core/, and the optional per-frame visual
+  tracker (--tracker-model).
+
+MobileNetV2
+  Google. Apache License 2.0.
+  The embedding backbone behind the identity gate (--embed-model),
+  finetuned by Ximilar.
+
+Identification is performed by the Ximilar collectibles API
+(https://api.ximilar.com), which is a paid hosted service and is not
+covered by this licence.

cardstream-0.2.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: cardstream
+Version: 0.2.0
+Summary: Real-time trading-card identification: a smart local client backed by Ximilar collectibles endpoints
+Author-email: Ximilar <tech@ximilar.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://cardstream.ai
+Project-URL: Documentation, https://cardstream.ai/docs
+Project-URL: Source, https://github.com/Ximilar-com/cardstream
+Project-URL: Issues, https://github.com/Ximilar-com/cardstream/issues
+Project-URL: Changelog, https://github.com/Ximilar-com/cardstream/blob/main/CHANGELOG.md
+Keywords: trading-cards,tcg,pokemon,card-identification,computer-vision,instance-segmentation,onnx,rf-detr,real-time,video-stream
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy>=1.23
+Requires-Dist: opencv-python-headless>=4.9
+Requires-Dist: requests>=2.31
+Provides-Extra: client
+Requires-Dist: websockets>=12; extra == "client"
+Requires-Dist: fastapi>=0.110; extra == "client"
+Requires-Dist: uvicorn[standard]>=0.29; extra == "client"
+Requires-Dist: pydantic>=2; extra == "client"
+Provides-Extra: torch
+Requires-Dist: torch>=2.1; extra == "torch"
+Requires-Dist: torchvision>=0.16; extra == "torch"
+Requires-Dist: transformers>=4.49; extra == "torch"
+Provides-Extra: onnx
+Requires-Dist: onnxruntime>=1.17; extra == "onnx"
+Provides-Extra: tflite
+Requires-Dist: ai-edge-litert>=1.0; extra == "tflite"
+Dynamic: license-file
+
+<div align="center">
+
+<img src="src/cardstream/webui/shared/logo.svg" alt="cardstream" width="320">
+
+**Point a camera at a trading card. Get the name, set and confidence the moment
+it enters the frame.**
+
+[![PyPI](https://img.shields.io/pypi/v/cardstream)](https://pypi.org/project/cardstream/)
+[![Python](https://img.shields.io/pypi/pyversions/cardstream)](https://pypi.org/project/cardstream/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+[![CI](https://github.com/Ximilar-com/cardstream/actions/workflows/ci.yml/badge.svg)](https://github.com/Ximilar-com/cardstream/actions/workflows/ci.yml)
+
+<!-- Replace with a ~15s screen recording of the browser UI identifying cards.
+     GitHub caps media at 10 MB. Prefer a GIF: MP4 does not render on PyPI,
+     which serves this same README as the project description. -->
+<img src="docs/media/demo.gif" alt="cardstream identifying cards live" width="720">
+
+</div>
+
+---
+
+No capture button, no per-frame API spam: **one paid API call per distinct
+card, not per frame.** All the vision runs on your machine; a single cropped
+JPEG leaves it each time a genuinely new card appears.
+
+## Quick start
+
+```bash
+uv tool install "cardstream[client,onnx]"   # or: pip install "cardstream[client,onnx]"
+export XIMILAR_API_KEY=...                  # the one environment variable anything here reads
+
+cardstream-web                              # browser UI on your webcam → http://127.0.0.1:8001
+```
+
+Hold a card up. The overlay shows the state machine thinking and the match when
+it lands.
+
+You will also need the model weights — they are too large to ship in the wheel.
+The [installer](#install) fetches them for you; a source checkout needs them
+dropped into `model/` (see **[Model weights](#model-weights)**).
+
+Headless, for rigs and streams:
+
+```bash
+cardstream-client --source 0                              # webcam, results to the terminal
+cardstream-web --source rtsp://user:pw@cam/stream1        # pull a camera
+cardstream-web --source rtmp://0.0.0.0:1935/live --listen # OBS pushes here
+```
+
+## Why it is cheap
+
+Identification is a paid call of roughly half a second, so cardstream never
+makes one per frame. A per-card **state machine** driven by free, entirely
+local signals decides when a fresh call is actually warranted:
+
+```
+            ┌─────────────────────── frame ───────────────────────┐
+            ▼                                                      │
+  1. detection (throttled)    card bbox + deskewed crop            │
+            │  no card → EMPTY                                     │
+            ▼                                                      │
+  2. MotionGate               mean frame-diff; low for N frames → SETTLED
+            │  still moving → MOVING                               │
+            ▼                                                      │
+  3. identity gate            pHash Hamming / embedding cosine → NEW card?
+            │  same card → IDENTIFIED (re-emit cached, 0 calls)    │
+            ▼                                                      │
+  4. identify (async/thread, debounced)  → IDENTIFIED + result ────┘
+```
+
+Detection itself is throttled in three tiers by the free motion gate (moving /
+static-with-card / empty heartbeat). The net effect is **one identify call per
+distinct card presentation, regardless of frame rate**. Hold a card still and
+it costs nothing more. Swap cards and it costs exactly one call.
+
+| Stage | Where it runs | Cost |
+|---|---|---|
+| Frame capture | browser webcam, or a pulled source | free |
+| Motion gate | local (mean frame-diff) | free |
+| Card location | local: detection (RF-DETR / RT-DETRv2) or segmentation (RF-DETR) | free |
+| Same-card identity gate | local (embedding cosine, or pHash) | free |
+| Identify lookup | Ximilar `collectibles/v2/*_id` | **paid, once per distinct card** |
+
+Everything above the last row is free and local. Nothing but that one crop
+leaves the process — there is no service in the path.
+
+## Model weights
+
+`model/` is gitignored, so a fresh checkout has no weights and the CLI says so
+at startup until you supply them. The installer and the Docker image fetch them
+for you.
+
+| Weight | Flag | Required |
+| --- | --- | --- |
+| **segmentation** — finds the card's outline, so the crop is deskewed and cut tight | `--segmentor-model` | **yes — the default locator** |
+| **similarity** — the embedding the identity gate compares crops with | `--embed-model` | **yes by default** (`--gate phash` needs none) |
+| detection — finds a bounding box instead | `--detector-model` | no — opt-in, replaces the segmentor |
+| tracking — carries the box between detections | `--tracker-model` | no — opt-in |
+
+Full details, download table and each export's I/O contract:
+**[`model/README.md`](model/README.md)** and the
+[model zoo](https://cardstream.ai/models).
+
+## Install
+
+**The quick way** (Linux/macOS — a venv in `~/.cardstream`, shims in
+`~/.local/bin`, model weights included):
+
+```bash
+curl -fsSL https://cardstream.ai/install.sh | sh
+cardstream-web --version
+```
+
+**From PyPI.** Extras are independent and ML imports are lazy, so any subset
+installs — but locating a card always needs a model, so pick a backend:
+
+```bash
+pip install "cardstream[client,onnx]"    # ONNX Runtime — what the shipped weights use
+pip install "cardstream[client,torch]"   # torch/transformers backends instead
+```
+
+**From a checkout:**
+
+```bash
+git clone https://github.com/Ximilar-com/cardstream && cd cardstream
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e '.[client,onnx]' --group dev
+```
+
+or in one step with the smoke checks: `./scripts/build-from-source.sh`
+(`--models` also fetches the weights).
+
+**Docker.** Read the security header in the `Dockerfile` before publishing any
+port:
+
+```bash
+docker build -t cardstream .
+docker run --rm -e XIMILAR_API_KEY -p 127.0.0.1:8001:8001 -v cardstream-models:/models cardstream
+```
+
+Releases carry the wheel, sdist and `SHA256SUMS`, which `install.sh` verifies.
+
+## Common recipes
+
+```bash
+cardstream-web --game "One Piece" --alphabet latin  # prefill: faster, more precise
+cardstream-web --set-code PBL                       # restrict matching to one set
+cardstream-web --camera-width 3840                  # more pixels to identify from
+cardstream-web --store-images crops/                # keep every crop you paid for
+cardstream-web --show-detection --debug             # see what was located, and why
+cardstream-web --gate phash                         # zero-ML identity gate
+cardstream-client --source card.jpg --loop          # a still image, on repeat
+```
+
+**Set `--alphabet` whenever you set `--game`.** Prefilling the game switches
+off the endpoint's own writing-system detection, and it then assumes latin — so
+a Japanese card comes back as its English print. Leave both unset and the
+endpoint works them out itself, which is why neither is defaulted.
+
+The shipped defaults **are** the tuned configuration: `make prod` passes no
+flags at all and runs the same pipeline `make dev` spells out flag by flag.
+
+## Documentation
+
+| | |
+| --- | --- |
+| **[CLI reference](docs/cli-reference.md)** | every flag and its default, generated from the parser |
+| **[Tuning](docs/tuning.md)** | call economics, detection filters, resolution, the settings dialog |
+| **[Locating the card](docs/locators.md)** | detection vs segmentation, expansion, visual tracking |
+| **[Frame sources](docs/sources.md)** | webcams, files, RTSP/RTMP/SRT, `--listen` |
+| **[Model weights](model/README.md)** | the model zoo and each export's contract |
+| **[Architecture](CLAUDE.md)** | the internals map, for contributors |
+
+## Verify the no-spam behaviour
+
+Run with `--debug` and watch the identify lines: they appear only on a new-card
+transition. Hold one card steady → exactly one. Swap to another → one more. Run
+at 10–15 fps throughout → still only those. The header's `N calls` badge counts
+the same thing. That is the whole point.
+
+## Development
+
+```bash
+make venv     # .venv with the client, onnx and dev dependencies
+make check    # lint + typecheck + both test suites — what CI runs
+make dev      # the tuned run plus diagnostics
+```
+
+The suite is entirely offline: no API key, camera, network or model files. See
+**[CONTRIBUTING.md](CONTRIBUTING.md)**.
+
+## Limitations
+
+- **Your Ximilar API key lives on the machine running the client**, and the
+  local web app is unauthenticated. That is the direct consequence of having no
+  service in the path. `--host` defaults to `127.0.0.1` — keep it there. See
+  **[SECURITY.md](SECURITY.md)**.
+- **Detector boxes are axis-aligned**, so an angled card's crop carries
+  background wedges. `--segmentor-model` — the default — is the answer: a mask
+  gives four corners and the crop is deskewed and cut tight.
+- **One card per frame.** The locator picks the best-scoring candidate.
+- **The tracker is presence, not identity.** An in-place card swap keeps its
+  score high, so it never replaces the embedding gate's same-vs-new decision.
+- **A game prefill costs alphabet detection** — see the warning above.
+- `--listen` and `--ffmpeg` need the system `ffmpeg` binary.
+
+## Licence
+
+[Apache-2.0](LICENSE). Every model architecture and runtime weight here is
+Apache-2.0 too — see [NOTICE](NOTICE). Identification is performed by the
+[Ximilar](https://www.ximilar.com) collectibles API, a paid hosted service.