docs: discussion doc on alternative distribution mechanisms for the cli#709
Open
aorumbayev wants to merge 3 commits intomainfrom
Open
docs: discussion doc on alternative distribution mechanisms for the cli#709aorumbayev wants to merge 3 commits intomainfrom
aorumbayev wants to merge 3 commits intomainfrom
Conversation
Create a non formal .md file providing an analysis of options available to simplify algokit cli distribution to achieve the following: - Complex multi tool distribution pipeline that requires apple developer account, canonical account and dealing with winget which in result only gives the end user a binary that still would not handle python installation for them after they jump into ide where an algokit example or a template has been scaffolded. - Acknowledge that pyinstaller was the most mature thing available at the time of implementing binary mode support but as of 2026 a few alternatives are available. Option A -> go over the codebase check the .github folder check all brew winget and pyinstaller related code including the tests in pytest that only run on pyinstaller binaries. Asses what would need to change if we are to do a switch to https://github.com/aorumbayev/uvget or a system similar to that (a single bash for unix and pwsh for windows - that take care of not just tool install like uvx or uv tool insall put pulling the uv itself and pulling the required python version for algokit to function then install the alogkit from pip). This allows dropping brew winget snap and pipx and simmply provide this single command (along with uv tool install algokit) to everyone. But must be phased so initially uv based installation is introduced and all other installation options moved to legacy and are explicitly marked for removal in next major updated (make the point for we dont have to break and remove what already works instantly). How would we make it smooth for people who had algokit installed via brew winget and etc? Option B. we continue distribution of binaries BUT only via curl with gpg signed executables from gh releases by leveraging https://ofek.dev/pyapp/latest/. This removes brew winget snap but we are still dealing with binaries but pyapp does dynamic python resolution so evaluate if this is fundamentally inferior to the approach with option A. C. Leave it as is and continue distributions of binaries but change default pip installation from pipx to uv tool install Create a laconic, easy to read, easy to approach by engineers working on this codebase document that ouytlines the options for the team to decide in and md file commit that and complete the task
aorumbayev
changed the title
|
Contributor
|
Option A sounds good with me. How do we currently handle Puya? It would be nice to align binary distribution. |
Contributor
|
Option A sounds good to me as well. I like the idea of having uv handling the Python distributions. I'm still a little bit unsure about all the migration paths, but I am sure we can figure that out during the implementation. |
|
If I understood correctly the option A would allow us to replace the binary shipping with a bootstrap script that 1. installs uv, 2. installs python using uv and 3. installs algokit using uv, right? In that case this would allow us to get rid of PyInstaller, code signing, brew, snap and winget at once, I mean, to me this looks like a no-brainer (but I might be missing more than something) |
Contributor
Author
|
@lempira i pushed a commit updating that we agreed on option A, let me know if i can merge |
aorumbayev
force-pushed
the
adr/uv-distribution
branch
from
6736177 to
2324663
Compare
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
4 participants
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.
ADR for discussion on replacing and improving current distribution mechanisms