Improve discoverability of message to set $PATH on Windows
See original GitHub issueSummary
A number of users are running into trouble installing Streamlit on Windows because they don’t realize they have to manually edit their $PATH
.
- https://github.com/streamlit/streamlit/issues/1252
- https://discuss.streamlit.io/t/getting-an-error-streamlit-is-not-recognized-as-an-internal-or-external-command-operable-program-or-batch-file/361/10
- https://stackoverflow.com/questions/60866205/python-streamlit-run-issue
Solution 1
Set the $PATH
automatically after installation on Windows.
Solution 2
If Solution 1 is impossible for some reason, then we could increase the discoverability of the message to set the $PATH on Windows, following this suggestion.
Ways to make it stand out:
- Make sure this message is at the bottom of the installation messages, as much as possible.
- Use console colors (is this possible on Windows?)
- Use capital letters. (If #2 doesn’t work.)
- Separate this message from others with a newline above and below.
We don’t need to do all of these options, but it’d be nice to have the minimum to improve discoverability.
Issue Analytics
- State:
- Created 3 years ago
- Comments:7 (6 by maintainers)
Top Results From Across the Web
How to set path at test discovery in visual studio?
Add the full path to the PATH Extension under Visual Studio -> Options -> Test Adapter for Google Test settings. Meanwhile the custom...
Read more >Recommended TCP/IP settings for WAN links with a MTU size ...
Method 1: Enable Path Maximum Transfer Unit (PMTU) black hole detection · Click Start, click Run, type regedit, and then click OK. ·...
Read more >Can't turn on Network Discovery - Windows Client
Open Control Panel, select System and Security, and then select Windows Firewall. · In the left pane, select Allow an app or feature...
Read more >Configure discovery methods for Configuration Manager
Configure discovery methods to find resources to manage from your network, Active Directory, and Azure Active Directory.
Read more >Discovery methods - Configuration Manager | Microsoft Learn
You can also specify a schedule to run discovery. Configure it to automatically create boundaries from the IP subnets and Active Directory ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
If we want Streamlit to add to the $PATH itself, this might have a solution:
https://stackoverflow.com/questions/1085852/interface-for-modifying-windows-environment-variables-from-python
I personally (as someone who isn’t anywhere near an expert on Windows programming) don’t feel comfortable integrating something like this as a solution. Which is why I’m advocating for a documentation based approach instead.
I agree that we shouldn’t modify the PATH, that feels too intrusive.
We already have the wiki content in the docs here, but it’s under ‘Troubleshooting’. It probably should be front and center in a ‘getting started’ section, and maybe the exact error message text could be part of the ‘Troubleshooting’ section.