-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updating markdown files #24
Conversation
cwebster-99
commented
Jun 6, 2024
- Updating README.md
- Updating SUPPORT.md
README.md
Outdated
- Remove this section from the README | ||
# Python environment tools for Visual Studio Code | ||
|
||
Performant Python environment tooling and support, such as locating all global Python installs and virtual environments. Powers environment environment tooling for the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) in [Visual Studio Code](https://code.visualstudio.com/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we should exclude the second sentence for now since that is not the current reality.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree
@DonJayamanne it also handles |
That looks to be correct - I updated your edit above to include those. Is there a place that references all of the supported environments I could pull from? |
I'd say yes, but anaconda, micromamba, conda, etc. are all different installs and thats not easily discoverable for documentation purposes.
Not explicity for |
README.md
Outdated
|
||
## Key Methodology | ||
|
||
We leverage Rust's performance to quickly scan for Python environments available to the user. When we find them, we gather all relevant information immediately to avoid the need for repeated discovery. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would like to call out out methodology and "principles" used in this work. Will likely need some additional details to ensure this is comprehensive
Co-authored-by: Karthik Nadig <[email protected]>
README.md
Outdated
- Venv | ||
- VirtualEnv | ||
- Python on your PATH | ||
- Mamba |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mamba now recomments using miniforge or micromamba
, hence I'd not mention this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove this line
README.md
Outdated
- VirtualEnv | ||
- Python on your PATH | ||
- Mamba | ||
- Micromamba |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets leave this out for now, its not easy to get the exe for micromamba,
We can add this later.
We might end up discovering the envrionments, but perhaps not the conda exe.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove this line
Co-authored-by: Karthik Nadig <[email protected]>