Skip to content

Leave beta: 1.0.0 messaging, full TapXR gestures, one connect path - #58

Merged
cursor[bot] merged 3 commits into
masterfrom
cursor/leave-beta-messaging-98b2
Oct 20, 2026
Merged

cursor[bot] merged 3 commits into
masterfrom
cursor/leave-beta-messaging-98b2

Conversation

@ilouzl

@ilouzl ilouzl commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This prepares the Tap Python SDK to leave beta in source. It does not publish to PyPI and does not create a tag or GitHub release.

Publishing 1.0.0 to PyPI is a separate maintainer step: run python scripts/prepare_release.py 1.0.0, commit, tag v1.0.0, and push the tag. The PyPI distribution name stays tap-python-sdk. The import name stays tapsdk (pip install tap-python-sdk then from tapsdk import connect). Do not publish a package named tapsdk.

Product facts applied (from Liron, 19–20 Oct 2026):

  • The TapXR developer firmware supports the full gesture set (taps, thumb swipes, pinches with hold, fist with hold). No firmware version number is invented.
  • TapXR and TapBand share the same BLE API. TapBand is coming soon, not for sale: https://www.tapwithus.com/tapband-waitlist/
  • All four SDKs receive raw gesture detections. In Python that is register_air_gesture_events. Swipes/pinches are not iOS/Android-only.
  • User-facing text no longer frames the product as “SDK v1 / SDK v2”. Class names TapSDK / TapSDK2 stay. Folder paths docs/v1/ and docs/v2/ stay for URL stability.
  • README and examples/connect.py enable input the same way as the developer portal hello_tap.py (hasattr(sdk, "set_input_mode") vs set_feature + tapping model).
  • Python 3.10+ is consistent. Beta labels are removed. Classifier is Development Status :: 5 - Production/Stable. Version in tapsdk/__version__.py is 1.0.0. Changelog entries stay under Unreleased until maintainers cut the release.

PR #56

PR #56 (Windows connection fix) is already merged into master (8122a99). This branch is based on that merge. It does not conflict. This PR does not merge or reopen #56. The only overlap is wording in Windows connect docs and a user-visible log line in _transport.py (same behavior).

Files changed and why

Package metadata (leave beta, keep PyPI name)

  • tapsdk/__version__.py — set version to 1.0.0
  • setup.py — keep DISTRIBUTION_NAME = "tap-python-sdk"; add Production/Stable classifier; clarify description
  • tests/test_setup.py — lock PyPI name tap-python-sdk, import package tapsdk, Python 3.10+, Production/Stable
  • docs/release-notes.md — Unreleased bullets for 1.0.0 messaging; historical 0.8.0/0.9.0 left as-is

First-run path

  • Readme.md — drop beta; one hello-tap path; air-gesture section; install = pip install tap-python-sdk + from tapsdk import ...; TapBand waitlist
  • examples/connect.py — same enable-input duck typing as the portal
  • examples/basic.py — note that this is the TapSDK / input-mode demo
  • examples/v2.py → examples/features.py — drop the “v2” filename; TapSDK2 feature-cycle demo

Agent kit

  • AGENTS.md — duck typing; no SDK v1/v2 framing; TapBand coming soon; install names
  • .cursor/rules/tap-sdk.mdc — same
  • .cursor/rules/diataxis-docs.mdc — docs are TapSDK / TapSDK2 API trees, not “SDK versions”
  • install-skills.sh — help text names devices and TapBand coming soon
  • .claude-plugin/marketplace.json — skills description names Tap Strap, TapXR, and TapBand (no extra TapBand parenthetical)
  • plugins/tap-python-sdk/.claude-plugin/plugin.json, plugins/tap-python-sdk/.codex-plugin/plugin.json — TapBand coming soon, same API
  • Skills (plugins/tap-python-sdk/skills/...): getting-started, tapping, vision-models, imu-motion, raw-sensors, knob, dpad, build-an-app, plus quickstart.py, knob.py, dpad.py, log_csv.py — full gestures; duck typing; no v1/v2 product framing; mermaid stateDiagram-v2 kept (diagram syntax)
  • tests/test_agent_kit.py — read marketplace JSON and SKILL.md as UTF-8 so Windows CI does not fail on curly quotes

Docs site

  • mkdocs.yml — nav titles TapSDK / TapSDK2; site description includes TapBand
  • docs/index.md — one hello-tap script; device table; full gestures; TapBand waitlist; PyPI vs import names
  • docs/how-to/install.md — Python 3.10+; pip install tap-python-sdk then from tapsdk import connect; do not pip install tapsdk
  • docs/reference/package.md, docs/reference/enumerations.md — class names; full UnifiedAirGestures set; PyPI vs import
  • docs/v1/**, docs/v2/** — titles and copy use TapSDK / TapSDK2; tutorials use duck typing; TapSDK2 tutorial sets tapping model + TRIGGER; air-gesture how-to; GitHub example links use master not branch v2
  • docs/windows-ble-connect-notes.md — "v1"/"v2" explained as detect_protocol() labels

User-visible code comments / docstrings

  • tapsdk/__init__.py, tapsdk/tap.py, tapsdk/tap2.py, tapsdk/enumerations.py, tapsdk/device_info.py, tapsdk/parsers.py — firmware/class wording; full gestures
  • tapsdk/_transport.py — Windows unpaired warning talks about TapSDK / TapSDK2 (behavior unchanged)

Local checks

  • flake8 examples tapsdk tests plugins — pass
  • pytest -v — 54 passed
  • mkdocs build --strict — pass
  • bash tests/check_install_skills.sh — pass
  • pytest tests/test_agent_kit.py tests/test_setup.py — pass after UTF-8 skill reads

Out of scope (maintainers)

  • Do not run prepare_release.py in this PR (Unreleased must stay until the real tag).
  • Do not push v1.0.0 or publish to PyPI from this PR.
  • Developer portal (dev.tapwithus.com) still says Beta; that site is outside this repo.
  • detect_protocol() still returns "v1" / "v2" internally. Docs folder URLs stay /v1/ and /v2/.
Open in Web Open in Cursor 

cursoragent and others added 2 commits October 20, 2026 14:17
… path

Match current product facts in docs, skills, and examples. Keep the PyPI
name tap-python-sdk; tapsdk stays the import name. Do not publish or tag.

Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
flake8 F821: the script already selected firmware with hasattr(sdk, "set_feature").

Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

Docs check

  • Status: OK
  • Affected quadrants: tutorial, how-to, reference, explanation
  • Gaps: none
  • Suggested edits: none

Drop the TapBand parenthetical from marketplace.json. Skill tests now
open SKILL.md as UTF-8 so Windows CI does not fail on curly quotes.

Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
@cursor
cursor Bot merged commit fc80140 into master Oct 20, 2026
21 checks passed
@ilouzl ilouzl mentioned this pull request Oct 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants