Skip to content
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

Merged
merged 6 commits into from
Jun 10, 2024
Merged

Updating markdown files #24

merged 6 commits into from
Jun 10, 2024

Conversation

cwebster-99
Copy link
Member

  • 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/).
Copy link
Member Author

@cwebster-99 cwebster-99 Jun 6, 2024

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree

@cwebster-99 cwebster-99 added the documentation Improvements or additions to documentation label Jun 6, 2024
DonJayamanne
DonJayamanne previously approved these changes Jun 6, 2024
README.md Outdated Show resolved Hide resolved
@karthiknadig
Copy link
Member

@DonJayamanne it also handles mamba micromamba miniconda miniforge etc right?

@cwebster-99
Copy link
Member Author

@DonJayamanne it also handles mamba micromamba miniconda miniforge etc right?

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?

@cwebster-99 cwebster-99 marked this pull request as ready for review June 6, 2024 21:02
@DonJayamanne
Copy link
Collaborator

DonJayamanne commented Jun 6, 2024

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.

t also handles mamba micromamba miniconda miniforge etc right?

Not explicity for mamba micromamba, I haven't added specific code to look for micromamba,
Will add a PR to look for some of the known paths for those.
So, lets leave that in there and make it known its supported

DonJayamanne
DonJayamanne previously approved these changes Jun 6, 2024
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.
Copy link
Member Author

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
Copy link
Collaborator

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.

Copy link
Collaborator

@DonJayamanne DonJayamanne Jun 6, 2024

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
Copy link
Collaborator

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.

Copy link
Collaborator

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 Show resolved Hide resolved
Co-authored-by: Karthik Nadig <[email protected]>
DonJayamanne
DonJayamanne previously approved these changes Jun 6, 2024
README.md Outdated Show resolved Hide resolved
@cwebster-99 cwebster-99 merged commit c14af66 into main Jun 10, 2024
24 checks passed
@cwebster-99 cwebster-99 deleted the congenial-goldfish branch June 10, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants