Document the PyPI release flow and make built artifacts PyPI-valid#11
Draft
Document the PyPI release flow and make built artifacts PyPI-valid#11
Conversation
Co-authored-by: isayahc <18591926+isayahc@users.noreply.github.com>
Co-authored-by: isayahc <18591926+isayahc@users.noreply.github.com>
Co-authored-by: isayahc <18591926+isayahc@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add deployment process for PYPI
Document the PyPI release flow and make built artifacts PyPI-valid
Mar 11, 2026
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.
OpenCAD referenced PyPI installation, but the repository did not explain how to publish a release. This PR adds a concrete PyPI release path and aligns packaging metadata so generated artifacts are accepted by the current upload toolchain.
Release documentation
RELEASING.mdwith the repository-native release flow:pyproject.tomlpython -m buildpython -m twine check dist/*README.mdso the release path is discoverable from the main docs entrypoint.Packaging compatibility
pyproject.tomlbuild requirements to pin setuptools to a PyPI-compatible range for this project’s current metadata shape.twine checkwhile still carrying the project license in release artifacts.Repository hygiene
dist/to.gitignoreto avoid committing generated release artifacts.Example release flow:
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
packaging.python.org/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.