Take the relay library from PyPI and prepare the package for release - #1
Merged
Conversation
The dae_RelayBoard library was carried as a git submodule because it looked like a setup.py-only project that had never been published. It has been on PyPI since August 2024, and that release is the same code: every module in the published wheel parses to an identical AST, differing only in comment formatting. The submodule bought nothing and cost a --recurse-submodules step for anyone cloning, so it is gone, along with the [tool.uv.sources] entry that pointed the dependency at it. The dependency now carries a >=1.5.2 floor rather than being unbounded. That path source had also been leaking into the sdist's pyproject.toml as a reference to a directory the sdist does not ship. The rest is metadata the package needs before it can be uploaded: - Fix the author email, which was missing the r in bitcrushtesting. - Add [project.urls] so the PyPI sidebar links back to the repository. - Add Development Status and Python version classifiers, and keywords. - Make the CI badge URL absolute. PyPI renders the README without any repo context, so the relative ../../actions/ form showed a broken image. - Rewrite the install section around `uv tool install denkovi-cli`, with the source checkout as the secondary path. Verified with ruff, pytest on all 58 tests, `uv sync --locked`, `twine check` on both artifacts, and installing the built wheel and sdist into clean virtualenvs that resolve every dependency from PyPI.
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
1 participant
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.
Everything needed before
denkovi-clican be uploaded to PyPI, plus removal of the submodule that was the apparent blocker.The submodule was not needed
dae_RelayBoardwas vendored as a git submodule on the assumption that this setup.py-only project had never been published. It has been on PyPI since 2024-08-02, and that release is the same code — every module in the published wheel parses to an identical AST, differing only in comment formatting (#Copyrightvs# Copyright). The README already noted the equivalence.So the submodule and the
[tool.uv.sources]path entry that pointed at it are gone.uv.locknow resolvesdae-relayboard==1.5.2frompypi.org/simplewith a hash, and the threesubmodules: recursivecheckouts in CI are dropped. Cloning no longer needs--recurse-submodules.This also fixes a leak:
[tool.uv.sources]was surviving into the sdist'spyproject.tomlaspath = "dae-py-relay-controller", a directory the sdist does not ship. uv ignores sources from dependency sdists so nothing broke in practice, but it was a dangling reference in published metadata. The rebuilt sdist is clean.Metadata
bitcushtesting.com→bitcrushtesting.com(missingr)[project.urls]Development Status :: 4 - Betaand Python 3.12 / 3.13 / 3.14dae-RelayBoard>=1.5.2README
The CI badge used
../../actions/..., which only resolves inside GitHub — PyPI renders the README with no repo context, so that would have been a broken image at the top of the project page. Now absolute, with a PyPI version badge alongside.The install section led with
git clone --recurse-submodules; it now leads withuv tool install denkovi-cli, with the source checkout as the secondary path. Credits and the licence note describe the library as a PyPI dependency rather than a vendored submodule.Verification
ruff check/ruff format --checkcleanpytest— 58 passeduv sync --lockedsucceeds against the regenerated locktwine checkPASSED on both wheel and sdistdenkovi --version,listandstatusall behave correctly with no board attachedNot included
The release workflow itself. Publishing needs a PyPI account with 2FA and, ideally, a Trusted Publisher (OIDC) bound to this repo — worth a follow-up PR once that is registered on PyPI.
denkovi-cliis currently unclaimed.