📝 docs: add package description and usage to README#46
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Mar 9, 2026
Merged
📝 docs: add package description and usage to README#46gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat merged 1 commit intotox-dev:mainfrom
Conversation
The README previously provided no information about what python-discovery does or how to use it, making it difficult for potential users to evaluate the package or get started quickly. Added a clear explanation of the package's purpose (discovering Python interpreters across multiple installation sources), a working usage example with get_interpreter(), and a list of supported specification formats. This addresses issue tox-dev#44 and improves the first-time user experience.
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.
The README previously had no information about what
python-discoverydoes or how to use it, making it difficult for potential users to evaluate the package or get started. This addresses issue #44.Added a clear explanation of the package's purpose (discovering Python interpreters across multiple installation sources like pyenv, mise, asdf, uv, and the Windows registry), a working usage example with
get_interpreter(), and a list of supported specification formats. 📚This improves the first-time user experience by answering the fundamental questions: what does this package do and how do I use it? The usage example demonstrates the core API with realistic code that users can adapt immediately.