Repository navigation
Leave beta: 1.0.0 messaging, full TapXR gestures, one connect path - #58
Merged
Merged
Conversation
… 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>
Contributor
Docs check
|
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>
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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, tagv1.0.0, and push the tag. The PyPI distribution name staystap-python-sdk. The import name staystapsdk(pip install tap-python-sdkthenfrom tapsdk import connect). Do not publish a package namedtapsdk.Product facts applied (from Liron, 19–20 Oct 2026):
register_air_gesture_events. Swipes/pinches are not iOS/Android-only.TapSDK/TapSDK2stay. Folder pathsdocs/v1/anddocs/v2/stay for URL stability.examples/connect.pyenable input the same way as the developer portal hello_tap.py (hasattr(sdk, "set_input_mode")vsset_feature+ tapping model).Development Status :: 5 - Production/Stable. Version intapsdk/__version__.pyis1.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 to1.0.0setup.py— keepDISTRIBUTION_NAME = "tap-python-sdk"; add Production/Stable classifier; clarify descriptiontests/test_setup.py— lock PyPI nametap-python-sdk, import packagetapsdk, Python 3.10+, Production/Stabledocs/release-notes.md— Unreleased bullets for 1.0.0 messaging; historical 0.8.0/0.9.0 left as-isFirst-run path
Readme.md— drop beta; one hello-tap path; air-gesture section; install =pip install tap-python-sdk+from tapsdk import ...; TapBand waitlistexamples/connect.py— same enable-input duck typing as the portalexamples/basic.py— note that this is the TapSDK / input-mode demoexamples/v2.py→examples/features.py— drop the “v2” filename; TapSDK2 feature-cycle demoAgent 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 APIplugins/tap-python-sdk/skills/...): getting-started, tapping, vision-models, imu-motion, raw-sensors, knob, dpad, build-an-app, plusquickstart.py,knob.py,dpad.py,log_csv.py— full gestures; duck typing; no v1/v2 product framing; mermaidstateDiagram-v2kept (diagram syntax)tests/test_agent_kit.py— read marketplace JSON andSKILL.mdas UTF-8 so Windows CI does not fail on curly quotesDocs site
mkdocs.yml— nav titlesTapSDK/TapSDK2; site description includes TapBanddocs/index.md— one hello-tap script; device table; full gestures; TapBand waitlist; PyPI vs import namesdocs/how-to/install.md— Python 3.10+;pip install tap-python-sdkthenfrom tapsdk import connect; do notpip install tapsdkdocs/reference/package.md,docs/reference/enumerations.md— class names; full UnifiedAirGestures set; PyPI vs importdocs/v1/**,docs/v2/**— titles and copy useTapSDK/TapSDK2; tutorials use duck typing; TapSDK2 tutorial sets tapping model + TRIGGER; air-gesture how-to; GitHub example links usemasternot branchv2docs/windows-ble-connect-notes.md—"v1"/"v2"explained asdetect_protocol()labelsUser-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 gesturestapsdk/_transport.py— Windows unpaired warning talks aboutTapSDK/TapSDK2(behavior unchanged)Local checks
flake8 examples tapsdk tests plugins— passpytest -v— 54 passedmkdocs build --strict— passbash tests/check_install_skills.sh— passpytest tests/test_agent_kit.py tests/test_setup.py— pass after UTF-8 skill readsOut of scope (maintainers)
prepare_release.pyin this PR (Unreleased must stay until the real tag).v1.0.0or publish to PyPI from this PR.detect_protocol()still returns"v1"/"v2"internally. Docs folder URLs stay/v1/and/v2/.