|
| 1 | +# Scientific Data Viewer v0.4.0 Release Notes |
| 2 | + |
| 3 | +## 🎉 Major Release: Extension Virtual Environment with uv Support |
| 4 | + |
| 5 | +Version 0.4.0 introduces a significant enhancement to the Scientific Data Viewer extension by adding support for a semi-standalone virtual environment managed by `uv`, providing better isolation and Python 3.13 support. This release transforms the extension from a Python extension-dependent tool into a more self-contained solution while maintaining full backward compatibility. |
| 6 | + |
| 7 | +## ✨ What's New |
| 8 | + |
| 9 | +### 🐍 Extension Virtual Environment System |
| 10 | + |
| 11 | +- **uv Integration**: New virtual environment system using `uv` for Python 3.13 installation and management |
| 12 | +- **Semi-Standalone Operation**: Extension can run independently with only `uv` as a requirement |
| 13 | +- **Isolated Storage**: Environment stored in VSCode's extension storage space for complete isolation |
| 14 | +- **Fallback Support**: Gracefully falls back to Python extension behavior if `uv` is unavailable |
| 15 | +- **Management Commands**: Complete CRUD operations for extension environment through intuitive UI |
| 16 | + |
| 17 | +### ⚙️ Enhanced Configuration System |
| 18 | + |
| 19 | +- **`scientificDataViewer.python.overridePythonInterpreter`**: Override Python interpreter path (highest priority) |
| 20 | +- **`scientificDataViewer.python.useExtensionOwnEnvironment`**: Enable extension's own uv virtual environment |
| 21 | +- **`scientificDataViewer.python.currentlyInUseInterpreter`**: Read-only tracking of active interpreter |
| 22 | +- **Priority Order**: Clear precedence system for interpreter selection |
| 23 | + |
| 24 | +### 🎯 Improved User Experience |
| 25 | + |
| 26 | +- **Quick Pick Interface**: Replaced notification dialogs with intuitive quick pick menus for uv environment management |
| 27 | +- **Status Bar Integration**: Shows virtual environment type and interpreter information |
| 28 | +- **Split View Support**: Works for files opened via file explorer (webviewPanel reuse) |
| 29 | +- **Better Error Handling**: Improved error messages and recovery mechanisms |
| 30 | + |
| 31 | +## 🔧 Technical Improvements |
| 32 | + |
| 33 | +### 🏗️ New Architecture Components |
| 34 | + |
| 35 | +- **`ExtensionVirtualEnvironmentManager`**: Core virtual environment management (701 lines) |
| 36 | +- **`ScientificDataEditorProvider`**: Handles file editor integration |
| 37 | +- **`utils.ts`**: Utility functions for path handling and quoting |
| 38 | +- **Refactored PythonManager**: Complete rewrite with improved initialization flow |
| 39 | + |
| 40 | +### 📁 Code Quality Enhancements |
| 41 | + |
| 42 | +- **API Surface Reduction**: PythonManager API simplified and streamlined |
| 43 | +- **Better Error Handling**: Enhanced error recovery for missing `uv` installation |
| 44 | +- **Path Quoting**: Fixed path quoting issues for spawn calls |
| 45 | +- **Test Updates**: All test suites updated to reflect new API changes |
| 46 | + |
| 47 | +### 🧪 Testing and Reliability |
| 48 | + |
| 49 | +- **Comprehensive Testing**: Updated all test suites for new architecture |
| 50 | +- **Error Scenarios**: Better handling of edge cases and missing dependencies |
| 51 | +- **Compilation Fixes**: Resolved test compilation issues |
| 52 | + |
| 53 | +## 🐛 Bug Fixes |
| 54 | + |
| 55 | +- **Path Handling**: Fixed path quoting issues for passing paths as args in spawn calls |
| 56 | +- **Environment Detection**: Improved Python interpreter detection and validation |
| 57 | +- **UI Consistency**: Better handling of environment switching and refresh scenarios |
| 58 | +- **Test Infrastructure**: Fixed compilation issues and removed obsolete tests |
| 59 | + |
| 60 | +## 📊 Configuration Priority System |
| 61 | + |
| 62 | +The extension now uses a clear priority system for Python interpreter selection: |
| 63 | + |
| 64 | +1. **`overridePythonInterpreter`** (manual override - highest precedence) |
| 65 | +2. **Extension environment** (if uv available and enabled) |
| 66 | +3. **Python extension interpreter** (fallback) |
| 67 | +4. **System Python** (final fallback) |
| 68 | + |
| 69 | +## 🎮 New Commands |
| 70 | + |
| 71 | +| Command | Description | |
| 72 | +| -------------------------------------------------------------- | ------------------------------------------------------------------ | |
| 73 | +| `Scientific Data Viewer: Manage Extension Virtual Environment` | Create, update, delete, and view extension environment information | |
| 74 | + |
| 75 | +## ⚙️ New Settings |
| 76 | + |
| 77 | +### Python Environment Settings |
| 78 | + |
| 79 | +- **`scientificDataViewer.python.overridePythonInterpreter`** |
| 80 | + |
| 81 | + - Type: `string` |
| 82 | + - Default: `""` |
| 83 | + - Description: Override Python interpreter path (takes precedence over all other options) |
| 84 | + |
| 85 | +- **`scientificDataViewer.python.useExtensionOwnEnvironment`** |
| 86 | + |
| 87 | + - Type: `boolean` |
| 88 | + - Default: `false` |
| 89 | + - Description: Use the extension's own virtual environment (requires uv) |
| 90 | + |
| 91 | +- **`scientificDataViewer.python.currentlyInUseInterpreter`** |
| 92 | + - Type: `string` |
| 93 | + - Default: `""` |
| 94 | + - Description: Currently active Python interpreter path (read-only, updated automatically) |
| 95 | + |
| 96 | +## 🚀 Getting Started with Extension Environment |
| 97 | + |
| 98 | +1. **Install uv**: Follow the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) |
| 99 | + |
| 100 | +2. **Enable Extension Environment**: |
| 101 | + |
| 102 | + - Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> |
| 103 | + - Type "Scientific Data Viewer: Show Settings" |
| 104 | + - Check "Scientific Data Viewer > Python > Use Extension Own Environment" |
| 105 | + |
| 106 | +3. **Manage Environment**: |
| 107 | + - Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> |
| 108 | + - Type "Scientific Data Viewer: Manage Extension Virtual Environment" |
| 109 | + - Choose from: Create, Update, Delete, or View Information |
| 110 | + |
| 111 | +## ⚠️ Known Issues |
| 112 | + |
| 113 | +- **Data Structure TreeView**: Not shown for manually created Webviews in Cursor (occurs sometimes) |
| 114 | +- **Environment Switching**: Some edge cases may require manual refresh (Ctrl+Shift+P -> SDV: Refresh) so that the status bar reflects the correct state, eg when deleting manually a virtual environment |
| 115 | + |
| 116 | +## 🔄 Breaking Changes |
| 117 | + |
| 118 | +- **PythonManager API**: Reduced API surface (some methods made private) |
| 119 | +- **UIController**: Constructor signature changed |
| 120 | +- **Test Interfaces**: Updated test interfaces to match new architecture |
| 121 | + |
| 122 | +## 📈 Impact |
| 123 | + |
| 124 | +This release significantly improves the extension's Python environment management capabilities: |
| 125 | + |
| 126 | +- **Better Isolation**: Extension environment won't interfere with other projects |
| 127 | +- **Python 3.13 Support**: Latest Python version for optimal performance |
| 128 | +- **Almost Self-Contained**: Minimal external dependencies (only requires uv) |
| 129 | +- **Backward Compatible**: Falls back gracefully when uv is not available |
| 130 | +- **User Control**: Clear configuration options and management commands |
| 131 | + |
| 132 | +## 📊 Statistics |
| 133 | + |
| 134 | +- **23 files changed** with **2,419 additions** and **1,623 deletions** |
| 135 | +- **Net change**: +796 lines |
| 136 | +- **New Components**: 3 major new TypeScript files |
| 137 | +- **API Simplification**: Reduced PythonManager complexity |
| 138 | +- **Test Coverage**: Updated all test suites |
| 139 | + |
| 140 | +## 🔮 What's Next |
| 141 | + |
| 142 | +This release establishes a solid foundation for future enhancements: |
| 143 | + |
| 144 | +- **Enhanced Environment Management**: More sophisticated environment switching |
| 145 | +- **Performance Improvements**: Optimized Python environment operations |
| 146 | +- **Better Integration**: Improved VSCode and Cursor compatibility |
| 147 | +- **Advanced Features**: More sophisticated data processing capabilities |
| 148 | + |
| 149 | +## 🙏 Acknowledgments |
| 150 | + |
| 151 | +Thank you to all users who provided feedback and contributed to this release. |
| 152 | + |
| 153 | +--- |
| 154 | + |
| 155 | +**Download now**: [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=eschalk0.scientific-data-viewer) | [Open VSX](https://open-vsx.org/extension/eschalk0/scientific-data-viewer) |
| 156 | + |
| 157 | +**Documentation**: [GitHub Repository](https://github.com/etienneschalk/scientific-data-viewer) |
| 158 | + |
| 159 | +**Report Issues**: [GitHub Issues](https://github.com/etienneschalk/scientific-data-viewer/issues) |
0 commit comments