reflex-react-joyride 0.2.0__tar.gz → 0.3.0__tar.gz

reflex_react_joyride-0.3.0/.gitignore

@@ -0,0 +1,245 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# ---------------------------------------------------------------- reflex-react-joyride
+# Compiled frontend and Reflex state, in the demo app and anywhere a component
+# is rendered from the repo root.
+.web/
+.states/
+reflex.lock
+assets/external/
+/assets/
+
+# Local tooling: the venv, uv/bun/npm caches and the interpreters used to run
+# the demo from this checkout.
+.devtools/
+.ruff_cache/
+
+# IDE settings and local agent output.
+.idea/
+Claude outputs/
+
+# Generated at build time by hatch-reflex-pyi. Running the stub generator from
+# src/ also makes rx.asset(shared=True) symlink the JSX wrapper into src/assets/,
+# which must never reach the sdist.
+src/**/*.pyi
+src/assets/
+
+# The demo's frontend lockfile, regenerated by `reflex compile`.
+demo/reflex.lock/

reflex_react_joyride-0.3.0/.nvmrc

@@ -0,0 +1 @@
+24

reflex_react_joyride-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+        exclude: ^docs/screenshots/
+      - id: trailing-whitespace
+
+  # Keep this rev in step with the ruff version in uv.lock.
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.2
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: uv run pyright
+        language: system
+        types: [python]
+        pass_filenames: false

reflex_react_joyride-0.3.0/.python-version

@@ -0,0 +1 @@
+3.14

reflex_react_joyride-0.3.0/AGENTS.md

@@ -0,0 +1,67 @@
+# AGENTS.md
+
+This repository is a Python package that wraps
+[react-joyride](https://react-joyride.com) as a Reflex component. The package
+lives in `src/reflex_react_joyride/`; `demo/` is a Reflex app for trying it.
+The layout follows Reflex's official
+[component template](https://github.com/reflex-dev/component-template).
+
+## Commands
+
+| Task | Command |
+|---|---|
+| Install | `uv sync` |
+| Lint, format, type-check | `uv run pre-commit run --all-files` |
+| Test | `uv run pytest` |
+| Regenerate the `.pyi` stub | `cd src && uv run python -m reflex_base.utils.pyi_generator reflex_react_joyride && rm -rf assets` |
+| Build (generates `.pyi` stubs) | `rm -rf dist && uv build` |
+| Run the demo | `cd demo && uv run reflex run` |
+| Check the demo compiles | `cd demo && uv run reflex compile` |
+
+Run the lint and test commands before every commit.
+
+## How the component is built
+
+- `joyride.py` defines `Joyride`, an `rx.NoSSRComponent` (react-joyride
+  touches `window`). Its `library` is not the npm package directly but the
+  local wrapper `joyride_tour.jsx`, shipped as a package asset, which calls
+  react-joyride's `useJoyride` hook; react-joyride itself is pinned through
+  `lib_dependencies` to `JOYRIDE_VERSION` in `constants.py`.
+- Do not name a module `component.py`, `app.py` or any other name in
+  `EXCLUDED_FILES` in `reflex_base.utils.pyi_generator`: the stub generator
+  skips those files silently.
+- Props are `rx.Var[...]` class attributes. Reflex sends snake_case names to
+  React as camelCase. Structured props (`Step`, `TourOptions`, `Locale`,
+  `TourStyles`, `FloatingOptions`) are `rx.PropsBase` classes in `props.py`;
+  give every field a `= None` default so type checkers accept partial
+  construction.
+- Events are `rx.EventHandler[spec]` attributes; every trigger receives the
+  flat `JoyrideEvent` payload from `events.py`.
+- `actions.py` holds the Python-side controls (`start`, `next_step`, ...),
+  which call into the wrapper through the tour id.
+- Export every public name from `__init__.py`.
+- After changing the JSX wrapper or `library`/`tag`, load the demo in a
+  browser: a broken import can compile and only fail at render.
+
+Reference: https://reflex.dev/docs/wrapping-react/overview/
+
+## Stubs
+
+`.pyi` files are generated by the `hatch-reflex-pyi` build hook during
+`uv build` (and on the first `uv sync`) so editors see each prop as a keyword
+argument. They are git-ignored; do not write them by hand. The hook skips
+generation when it already built the same version, so regenerate the stub with
+the command above after changing props.
+
+## Tests
+
+Tests live in `tests/` and check what the component imports and how it renders
+(`str(component)` is the generated JSX). Add a test for each new prop or event.
+
+## Releasing
+
+Versions come from git tags (`uv-dynamic-versioning`); there is no version in
+`pyproject.toml`. Merge `develop` into `main`, then push a tag `vX.Y.Z` on
+`main`: `.github/workflows/release.yml` tests, builds and publishes to PyPI
+through trusted publishing. Do not rename that workflow file or its `pypi`
+environment, PyPI's trusted publisher is bound to them.

reflex_react_joyride-0.3.0/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [0.3.0] - 2026-10-25
+
+### Changed
+
+- Migrated to the layout of Reflex's official
+  [component template](https://github.com/reflex-dev/component-template):
+  - the package moved from `custom_components/` to `src/reflex_react_joyride/`
+    and the demo app from `react_joyride_demo/` to `demo/`;
+  - builds with hatchling instead of setuptools;
+  - the version comes from the git tag (`uv-dynamic-versioning`) and is no
+    longer written in `pyproject.toml`;
+  - the `.pyi` stubs are generated at build time by `hatch-reflex-pyi` and are
+    no longer committed;
+  - pre-commit runs ruff, pyright and file checks; new `AGENTS.md`.
+- Python 3.14 is supported and tested.
+- CI runs pre-commit (with pyright) instead of bare ruff, and the release
+  workflow checks that the built version matches the tag and that the wheel
+  ships the stub.
+
+### Fixed
+
+- Type checkers no longer require every field of `Step`, `TourOptions`,
+  `Locale`, `TourStyles`, `FloatingOptions` and `SpotlightPadding`: all fields
+  default to `None`, so `TourOptions(z_index=1000)` type-checks. Serialization
+  is unchanged.
+- `steps` is typed as a sequence of `Step` objects or dicts, so passing
+  `[rjr.Step(...)]` or a `list[dict]` State var no longer shows a type error.
+- `options`, `locale`, `styles` and `floating_options` accept their typed
+  objects (`TourOptions`, `Locale`, `TourStyles`, `FloatingOptions`) in the
+  stubs, matching the documented usage.
+
+## [0.2.0] - 2026-10-25
+
+### Changed
+
+- Requires **Reflex 0.10.0** or newer (was 0.9.11).
+- Requires **Python 3.11** or newer; Python 3.10 is no longer supported, in
+  line with Reflex 0.10.
+- Build backend requires `setuptools>=78.1.1`.
+- CI and release workflows use Node 24 (`.nvmrc`), and every JavaScript action
+  is forced onto the Node 24 runtime.
+- The release workflow only publishes tags that point to a commit on `main`.
+- `reflex component build` no longer exists in Reflex 0.10: build with
+  `uv build` and regenerate the `.pyi` stubs with
+  `python -m reflex_base.utils.pyi_generator` (see the README).
+- Regenerated `joyride.pyi`, so the `tooltip` docstring matches the source.
+
+### Unchanged
+
+- The Python API (`joyride`, props, actions, events and constants) and the
+  bundled react-joyride 3.2.0 are the same as in 0.1.0.
+
+## [0.1.0] - 2026-09-17
+
+### Added
+
+- First release: Reflex wrapper for react-joyride 3.2.0 with typed props,
+  controlled and uncontrolled modes, Python actions, per-event triggers,
+  custom tooltip and beacon components, and a four page demo app.
+
+[0.3.0]: https://github.com/ecrespo/reflex-react-joyride/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/ecrespo/reflex-react-joyride/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/ecrespo/reflex-react-joyride/releases/tag/v0.1.0

{reflex_react_joyride-0.2.0 → reflex_react_joyride-0.3.0}/PKG-INFO

@@ -1,29 +1,28 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: reflex-react-joyride
-Version: 0.2.0
+Version: 0.3.0
 Summary: Reflex custom component for react-joyride: guided product tours and onboarding walkthroughs, with controlled mode, theming, custom tooltips and Python-driven controls
-Author-email: Ernesto Crespo <ecrespo@gmail.com>
-License: MIT
 Project-URL: Homepage, https://github.com/ecrespo/reflex-react-joyride
 Project-URL: Source, https://github.com/ecrespo/reflex-react-joyride
 Project-URL: Issues, https://github.com/ecrespo/reflex-react-joyride/issues
-Keywords: reflex,reflex-custom-components,react-joyride,joyride,tour,onboarding,walkthrough,product-tour
+Author-email: Ernesto Crespo <ecrespo@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: joyride,onboarding,product-tour,react-joyride,reflex,reflex-custom-components,tour,walkthrough
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: User Interfaces
 Classifier: Typing :: Typed
 Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: reflex>=0.10.0
-Dynamic: license-file
+Description-Content-Type: text/markdown
 
 # reflex-react-joyride
 
@@ -55,13 +54,13 @@ The four pages of the demo app, in order:
 
 | | Version |
 | --- | --- |
-| Python | 3.11, 3.12 or 3.13 |
+| Python | 3.11 to 3.14 |
 | Reflex | **0.10.0** or newer |
 | react-joyride | 3.2.0 (bundled, installed by Reflex on first compile) |
 | Node.js (development and CI only) | 24 LTS, pinned in `.nvmrc` |
 
-> **Upgrading from 0.1.x:** 0.2.0 requires Reflex 0.10 and drops Python 3.10,
-> following Reflex itself. The Python API is unchanged. See the
+> **Upgrading from 0.1.x:** 0.2.0 and later require Reflex 0.10 and drop
+> Python 3.10, following Reflex itself. The Python API is unchanged. See the
 > [changelog](CHANGELOG.md).
 
 ## Installation
@@ -327,56 +326,68 @@ usually exactly what you want.
 
 ## Demo app
 
-The `react_joyride_demo/` folder is a four page Reflex app covering the basics,
-controlled mode, theming with a Reflex tooltip, and the awkward cases (targets
-that appear late or never, spotlight targets, scrolling, modal steps, blocked
-interaction):
+The `demo/` folder is a four page Reflex app covering the basics, controlled
+mode, theming with a Reflex tooltip, and the awkward cases (targets that appear
+late or never, spotlight targets, scrolling, modal steps, blocked interaction):
 
 ```bash
 uv sync
-cd react_joyride_demo
+cd demo
 uv run reflex run
 ```
 
 ## Development
 
+The project follows the layout of Reflex's official
+[component template](https://github.com/reflex-dev/component-template): the
+package lives in `src/reflex_react_joyride/`, it builds with hatchling, the
+version comes from the git tag, and the `.pyi` stubs are generated at build
+time by `hatch-reflex-pyi` instead of being committed.
+
 ```bash
-uv sync                         # creates .venv and installs the package in editable mode
+uv sync                                # creates .venv, installs the package in editable mode
+uv run pre-commit install              # once: ruff, pyright and file checks on every commit
+uv run pre-commit run --all-files      # lint, format and type-check
 uv run pytest
-uv run ruff check .
-uv run ruff format --check .
-uv build                        # builds the sdist and wheel into dist/
+rm -rf dist && uv build                # sdist and wheel, stubs included, into dist/
 ```
 
-`reflex component` was removed in Reflex 0.10. The `.pyi` stubs are committed;
-regenerate them after changing the component's props:
+`uv sync` writes `src/reflex_react_joyride/joyride.pyi` the first time (it is
+git-ignored). The build hook skips generation when the version hasn't changed,
+so after changing the component's props regenerate the stub yourself, and
+always build into an empty `dist/`:
 
 ```bash
-uv run python -m reflex_base.utils.pyi_generator custom_components/reflex_react_joyride
+cd src && uv run python -m reflex_base.utils.pyi_generator reflex_react_joyride && rm -rf assets
 ```
 
+`reflex component init/build` no longer exist in Reflex 0.10; the template and
+the commands above replace them. See [`AGENTS.md`](AGENTS.md) for the
+conventions coding agents (and humans) should follow.
+
 CI runs on Node 24 (`.nvmrc`); use the same version locally (`nvm use`) if you
 compile the demo with Node instead of Bun.
 
 ## Releasing
 
-Releases are published to PyPI by the `Release` workflow through Trusted
-Publishing, so no token is stored anywhere:
+The version is not written anywhere in the code: it comes from the git tag
+(`uv-dynamic-versioning`). Releases are published to PyPI by the `Release`
+workflow through Trusted Publishing, so no token is stored anywhere:
 
-1. On `develop`, bump `version` in `pyproject.toml` and add an entry to
-   `CHANGELOG.md`.
+1. On `develop`, add an entry to `CHANGELOG.md`.
 2. Open a PR from `develop` to `main` and merge it once the Quality and
    Security workflows pass.
 3. Tag the merge commit on `main` and push the tag:
 
    ```bash
    git switch main && git pull
-   git tag v0.2.0 && git push origin v0.2.0
+   git tag v0.3.0 && git push origin v0.3.0
    ```
 
-The workflow refuses tags that are not on `main` or that don't match the
-`pyproject.toml` version, then runs the tests, builds, publishes to PyPI with
-build provenance attestations and creates the GitHub release.
+The workflow refuses tags that are not on `main`, runs the tests, builds,
+checks that the built version matches the tag and that the stubs are in the
+wheel, publishes to PyPI with build provenance attestations and creates the
+GitHub release.
 
 ## License
 

{reflex_react_joyride-0.2.0 → reflex_react_joyride-0.3.0}/README.md

@@ -28,13 +28,13 @@ The four pages of the demo app, in order:
 
 | | Version |
 | --- | --- |
-| Python | 3.11, 3.12 or 3.13 |
+| Python | 3.11 to 3.14 |
 | Reflex | **0.10.0** or newer |
 | react-joyride | 3.2.0 (bundled, installed by Reflex on first compile) |
 | Node.js (development and CI only) | 24 LTS, pinned in `.nvmrc` |
 
-> **Upgrading from 0.1.x:** 0.2.0 requires Reflex 0.10 and drops Python 3.10,
-> following Reflex itself. The Python API is unchanged. See the
+> **Upgrading from 0.1.x:** 0.2.0 and later require Reflex 0.10 and drop
+> Python 3.10, following Reflex itself. The Python API is unchanged. See the
 > [changelog](CHANGELOG.md).
 
 ## Installation
@@ -300,56 +300,68 @@ usually exactly what you want.
 
 ## Demo app
 
-The `react_joyride_demo/` folder is a four page Reflex app covering the basics,
-controlled mode, theming with a Reflex tooltip, and the awkward cases (targets
-that appear late or never, spotlight targets, scrolling, modal steps, blocked
-interaction):
+The `demo/` folder is a four page Reflex app covering the basics, controlled
+mode, theming with a Reflex tooltip, and the awkward cases (targets that appear
+late or never, spotlight targets, scrolling, modal steps, blocked interaction):
 
 ```bash
 uv sync
-cd react_joyride_demo
+cd demo
 uv run reflex run
 ```
 
 ## Development
 
+The project follows the layout of Reflex's official
+[component template](https://github.com/reflex-dev/component-template): the
+package lives in `src/reflex_react_joyride/`, it builds with hatchling, the
+version comes from the git tag, and the `.pyi` stubs are generated at build
+time by `hatch-reflex-pyi` instead of being committed.
+
 ```bash
-uv sync                         # creates .venv and installs the package in editable mode
+uv sync                                # creates .venv, installs the package in editable mode
+uv run pre-commit install              # once: ruff, pyright and file checks on every commit
+uv run pre-commit run --all-files      # lint, format and type-check
 uv run pytest
-uv run ruff check .
-uv run ruff format --check .
-uv build                        # builds the sdist and wheel into dist/
+rm -rf dist && uv build                # sdist and wheel, stubs included, into dist/
 ```
 
-`reflex component` was removed in Reflex 0.10. The `.pyi` stubs are committed;
-regenerate them after changing the component's props:
+`uv sync` writes `src/reflex_react_joyride/joyride.pyi` the first time (it is
+git-ignored). The build hook skips generation when the version hasn't changed,
+so after changing the component's props regenerate the stub yourself, and
+always build into an empty `dist/`:
 
 ```bash
-uv run python -m reflex_base.utils.pyi_generator custom_components/reflex_react_joyride
+cd src && uv run python -m reflex_base.utils.pyi_generator reflex_react_joyride && rm -rf assets
 ```
 
+`reflex component init/build` no longer exist in Reflex 0.10; the template and
+the commands above replace them. See [`AGENTS.md`](AGENTS.md) for the
+conventions coding agents (and humans) should follow.
+
 CI runs on Node 24 (`.nvmrc`); use the same version locally (`nvm use`) if you
 compile the demo with Node instead of Bun.
 
 ## Releasing
 
-Releases are published to PyPI by the `Release` workflow through Trusted
-Publishing, so no token is stored anywhere:
+The version is not written anywhere in the code: it comes from the git tag
+(`uv-dynamic-versioning`). Releases are published to PyPI by the `Release`
+workflow through Trusted Publishing, so no token is stored anywhere:
 
-1. On `develop`, bump `version` in `pyproject.toml` and add an entry to
-   `CHANGELOG.md`.
+1. On `develop`, add an entry to `CHANGELOG.md`.
 2. Open a PR from `develop` to `main` and merge it once the Quality and
    Security workflows pass.
 3. Tag the merge commit on `main` and push the tag:
 
    ```bash
    git switch main && git pull
-   git tag v0.2.0 && git push origin v0.2.0
+   git tag v0.3.0 && git push origin v0.3.0
    ```
 
-The workflow refuses tags that are not on `main` or that don't match the
-`pyproject.toml` version, then runs the tests, builds, publishes to PyPI with
-build provenance attestations and creates the GitHub release.
+The workflow refuses tags that are not on `main`, runs the tests, builds,
+checks that the built version matches the tag and that the stubs are in the
+wheel, publishes to PyPI with build provenance attestations and creates the
+GitHub release.
 
 ## License