docs: use editable install with the unidesk entry point#10
Open
YatesMold wants to merge 2 commits into
Open
Conversation
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.
While trying out UniDesk for the first time, I noticed the run command in the README produces an
ImportErrorbecausemain.pyuses relative imports.I then noticed that
setup.pyalready defines a properunideskconsole_script entry point — so the intended workflow seems to bepip install -e .followed by justunidesk. Updated the README to reflect this.Also added venv setup steps since modern Debian-based distros block system pip installs by default (PEP 668), which trips up newcomers.
Verified that
pip install -e . && unidesklaunches the app correctly on my machine.