Refactor: Modernize and make envpath cross-platform#1
Open
kwameboame wants to merge 1 commit into
Open
Conversation
This commit brings several major improvements to the envpath tool:
- **Python Compatibility:** Updated to require Python 3.7+ and removed unnecessary dependencies like `argparse`.
- **Cross-Platform Support:**
- Replaced Windows-specific batch files with a JSON configuration file (`~/.envpath/environments.json`) for storing environment paths.
- The tool now prints activation commands for `cmd`, `PowerShell` (Windows), and `bash/zsh` (Unix-like systems) instead of trying to activate environments directly.
- Uses `pathlib` for robust path handling.
- **Virtual Environment Handling:**
- `envpath --save` now attempts to detect and store the active `VIRTUAL_ENV` path.
- `envpath --open` uses the stored venv path or falls back to common names like `.venv` or `venv` within the project directory.
- **Documentation:**
- `README.md` has been extensively updated to reflect new functionality, cross-platform nature, and usage.
- **Testing:**
- Added a comprehensive unit test suite (`tests/test_envpath.py`) using `unittest` and `unittest.mock` to cover core logic.
- **Repository Cleanup:**
- Removed outdated `.travis.yaml`.
- Added `.gitignore` for build artifacts (`build/`, `dist/`, `*.egg-info/`) and cleaned these directories.
The tool is now more robust, user-friendly for a wider range of operating systems, and maintainable with the inclusion of tests.
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.
This commit brings several major improvements to the envpath tool:
argparse.~/.envpath/environments.json) for storing environment paths.cmd,PowerShell(Windows), andbash/zsh(Unix-like systems) instead of trying to activate environments directly.pathlibfor robust path handling.envpath --savenow attempts to detect and store the activeVIRTUAL_ENVpath.envpath --openuses the stored venv path or falls back to common names like.venvorvenvwithin the project directory.README.mdhas been extensively updated to reflect new functionality, cross-platform nature, and usage.tests/test_envpath.py) usingunittestandunittest.mockto cover core logic..travis.yaml..gitignorefor build artifacts (build/,dist/,*.egg-info/) and cleaned these directories.The tool is now more robust, user-friendly for a wider range of operating systems, and maintainable with the inclusion of tests.