ms-components 0.3.4__tar.gz → 0.4.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. ms_components-0.4.0/MANIFEST.in +3 -0
  2. {ms_components-0.3.4 → ms_components-0.4.0}/PKG-INFO +39 -9
  3. ms_components-0.4.0/README.md +50 -0
  4. ms_components-0.4.0/licenses/qt-themes-LICENSE.txt +24 -0
  5. {ms_components-0.3.4 → ms_components-0.4.0}/pyproject.toml +8 -6
  6. ms_components-0.4.0/src/ms_components/ketcher.py +156 -0
  7. ms_components-0.4.0/src/ms_components/ms_projects/__init__.py +4 -0
  8. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_projects/app.py +8 -2
  9. ms_components-0.4.0/src/ms_components/ms_projects/backend.py +15 -0
  10. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_projects/browser.py +25 -13
  11. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_projects/widget.py +9 -3
  12. ms_components-0.4.0/src/ms_components/ms_pymol/__init__.py +49 -0
  13. ms_components-0.4.0/src/ms_components/ms_pymol/icons/style.svg +1 -0
  14. ms_components-0.4.0/src/ms_components/ms_pymol/scene.py +470 -0
  15. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/widget.py +8 -0
  16. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_settings/panel.py +3 -2
  17. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/__init__.py +2 -0
  18. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/smart_table_view.py +15 -1
  19. ms_components-0.4.0/src/ms_components/ms_table/table_interaction.py +42 -0
  20. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_tutorial/bindings.py +1 -0
  21. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_tutorial/controller.py +30 -6
  22. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_tutorial/overlay.py +18 -8
  23. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components.egg-info/PKG-INFO +39 -9
  24. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components.egg-info/SOURCES.txt +12 -5
  25. ms_components-0.4.0/src/ms_components.egg-info/requires.txt +23 -0
  26. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components.egg-info/scm_file_list.json +16 -0
  27. ms_components-0.4.0/src/ms_components.egg-info/scm_version.json +8 -0
  28. ms_components-0.4.0/tests/conftest.py +1 -0
  29. ms_components-0.4.0/tests/test_ketcher.py +39 -0
  30. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_ms_projects_widget.py +45 -0
  31. ms_components-0.4.0/tests/test_pymol_scene.py +153 -0
  32. ms_components-0.4.0/tests/test_table_interaction.py +58 -0
  33. ms_components-0.4.0/tests/test_tool_panel.py +177 -0
  34. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_tutorial.py +80 -4
  35. ms_components-0.3.4/README.md +0 -29
  36. ms_components-0.3.4/docs/api_reference.md +0 -102
  37. ms_components-0.3.4/docs/examples.md +0 -139
  38. ms_components-0.3.4/docs/index.md +0 -60
  39. ms_components-0.3.4/docs/ms_tutorial.md +0 -160
  40. ms_components-0.3.4/docs/usage.md +0 -201
  41. ms_components-0.3.4/src/ms_components/ms_projects/__init__.py +0 -4
  42. ms_components-0.3.4/src/ms_components/ms_pymol/__init__.py +0 -17
  43. ms_components-0.3.4/src/ms_components.egg-info/requires.txt +0 -8
  44. ms_components-0.3.4/src/ms_components.egg-info/scm_version.json +0 -8
  45. {ms_components-0.3.4 → ms_components-0.4.0}/.github/workflows/docs.yml +0 -0
  46. {ms_components-0.3.4 → ms_components-0.4.0}/.github/workflows/publish.yml +0 -0
  47. {ms_components-0.3.4 → ms_components-0.4.0}/.gitignore +0 -0
  48. {ms_components-0.3.4 → ms_components-0.4.0}/LICENSE +0 -0
  49. {ms_components-0.3.4 → ms_components-0.4.0}/examples/tutorial_demo.py +0 -0
  50. {ms_components-0.3.4 → ms_components-0.4.0}/examples/tutorial_demo.toml +0 -0
  51. {ms_components-0.3.4 → ms_components-0.4.0}/setup.cfg +0 -0
  52. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/__init__.py +0 -0
  53. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/backdrop.py +0 -0
  54. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/base.qss +0 -0
  55. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/chips.py +0 -0
  56. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/listview.py +0 -0
  57. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_dockwidget/__init__.py +0 -0
  58. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_dockwidget/resources/__init__.py +0 -0
  59. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_dockwidget/resources/icons/__init__.py +0 -0
  60. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_dockwidget/resources/icons/folder.svg +0 -0
  61. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_dockwidget/widget.py +0 -0
  62. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_executors.py +0 -0
  63. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/__init__.py +0 -0
  64. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/bridge.py +0 -0
  65. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/cards.py +0 -0
  66. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/config.py +0 -0
  67. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/detail_panel.py +0 -0
  68. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/formatting.py +0 -0
  69. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/job_cards.py +0 -0
  70. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/models.py +0 -0
  71. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/palette.py +0 -0
  72. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/polling.py +0 -0
  73. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_monitor/widget.py +0 -0
  74. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_projects/scratch.py +0 -0
  75. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/actions.svg +0 -0
  76. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/box.svg +0 -0
  77. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/center.svg +0 -0
  78. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/display.svg +0 -0
  79. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/hide.svg +0 -0
  80. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/hydrogens-polar.svg +0 -0
  81. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/hydrogens.svg +0 -0
  82. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/menu.svg +0 -0
  83. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/orient.svg +0 -0
  84. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/presets.svg +0 -0
  85. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/rock.svg +0 -0
  86. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/selection.svg +0 -0
  87. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/settings.svg +0 -0
  88. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/icons/zoom.svg +0 -0
  89. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_pymol/plugins.py +0 -0
  90. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_settings/__init__.py +0 -0
  91. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_stepper.py +0 -0
  92. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/action_header.py +0 -0
  93. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/cell_delegate.py +0 -0
  94. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/column_panel.py +0 -0
  95. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/example_usage.py +0 -0
  96. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/filter_panel.py +0 -0
  97. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/columns.svg +0 -0
  98. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/export.svg +0 -0
  99. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/filter.svg +0 -0
  100. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/menu.svg +0 -0
  101. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/reload.svg +0 -0
  102. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/search.svg +0 -0
  103. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/settings.svg +0 -0
  104. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/sort-asc.svg +0 -0
  105. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/sort-desc.svg +0 -0
  106. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/icons/sort.svg +0 -0
  107. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/metric_filter_bar.py +0 -0
  108. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/pagination_control.py +0 -0
  109. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/query_builder.py +0 -0
  110. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/session_provider.py +0 -0
  111. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/sort_panel.py +0 -0
  112. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/table_config.py +0 -0
  113. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/table_model.py +0 -0
  114. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/test_external_filters.py +0 -0
  115. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_table/test_toolbar.py +0 -0
  116. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_tutorial/__init__.py +0 -0
  117. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/ms_tutorial/models.py +0 -0
  118. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/opengl.py +0 -0
  119. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/pagination.py +0 -0
  120. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/palettes.py +0 -0
  121. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/step_dialog.py +0 -0
  122. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/theme.py +0 -0
  123. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/tool_panel.py +0 -0
  124. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components/wheel.py +0 -0
  125. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components.egg-info/dependency_links.txt +0 -0
  126. {ms_components-0.3.4 → ms_components-0.4.0}/src/ms_components.egg-info/top_level.txt +0 -0
  127. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_app_settings.py +0 -0
  128. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_chips.py +0 -0
  129. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_dock_window.py +0 -0
  130. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_executors_ui.py +0 -0
  131. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_molsuite_monitor_bridge.py +0 -0
  132. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_molsuite_monitor_widgets.py +0 -0
  133. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_monitor_config.py +0 -0
  134. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_opengl.py +0 -0
  135. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_progress_column.py +0 -0
  136. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_project_browser.py +0 -0
  137. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_pymol_grid.py +0 -0
  138. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_pymol_toolbar.py +0 -0
  139. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_query_builder_keyset.py +0 -0
  140. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_shift_hscroll.py +0 -0
  141. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_split_button_style.py +0 -0
  142. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_step_dialog.py +0 -0
  143. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_table_toolbar.py +0 -0
  144. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_table_view_state.py +0 -0
  145. {ms_components-0.3.4 → ms_components-0.4.0}/tests/test_theme_contrast.py +0 -0
  146. {ms_components-0.3.4 → ms_components-0.4.0}/zensical.toml +0 -0
@@ -0,0 +1,3 @@
1
+ # setuptools-scm puts every git-tracked file in the sdist; docs/ is repo
2
+ # working material. licenses/ stays -- it is third-party attribution.
3
+ prune docs
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ms_components
3
- Version: 0.3.4
3
+ Version: 0.4.0
4
4
  Summary: PySide6 UI components for MolSuite: smart table, project browser, job monitor, PyMOL dock, steppers.
5
5
  Author: Mario S. Valdés-Tresanco, Mario E. Valdés-Tresanco
6
6
  License-Expression: MIT
@@ -17,12 +17,21 @@ Classifier: Environment :: X11 Applications :: Qt
17
17
  Requires-Python: >=3.12
18
18
  Description-Content-Type: text/markdown
19
19
  License-File: LICENSE
20
- Requires-Dist: ms_env>=0.2.0
21
- Requires-Dist: ms_flow>=0.2.0
22
20
  Requires-Dist: PySide6>=6.5
23
- Requires-Dist: pymol-open-source>=3.2.0a0
24
- Requires-Dist: sqlmodel>=0.0.14
21
+ Provides-Extra: monitor
22
+ Requires-Dist: pydantic>=2.0; extra == "monitor"
23
+ Provides-Extra: projects
24
+ Requires-Dist: ms_flow>=0.2.0; extra == "projects"
25
+ Provides-Extra: pymol
26
+ Requires-Dist: pymol-open-source>=3.2.0a0; extra == "pymol"
27
+ Provides-Extra: steps
28
+ Requires-Dist: ms_env>=0.2.0; extra == "steps"
29
+ Provides-Extra: table
30
+ Requires-Dist: sqlmodel>=0.0.14; extra == "table"
31
+ Provides-Extra: all
32
+ Requires-Dist: ms_components[monitor,projects,pymol,steps,table]; extra == "all"
25
33
  Provides-Extra: dev
34
+ Requires-Dist: ms_components[all]; extra == "dev"
26
35
  Requires-Dist: pytest>=7.0; extra == "dev"
27
36
  Dynamic: license-file
28
37
 
@@ -35,18 +44,39 @@ PyMOL dock, steppers and the shared theming (`themes/` + `base.qss`).
35
44
  Python binds existing widgets/signals, while content can be defined in Python or
36
45
  TOML. Try `PYTHONPATH=src python examples/tutorial_demo.py` from a source checkout.
37
46
 
38
- Part of the [MolSuite](https://molsuite.github.io/) stack. Built on top of
39
- [`ms_flow`](https://github.com/MolSuite/ms_flow).
47
+ Part of the [MolSuite](https://molsuite.github.io/) stack. The project catalog integrates
48
+ with [`ms_flow`](https://github.com/MolSuite/ms_flow) when that backend is needed.
40
49
 
41
50
  ## Install
42
51
 
43
- PyMOL is installed automatically from the `pymol-open-source` alpha wheels on
44
- PyPI (`>=3.2.0a0`):
52
+ The base installation provides Qt widgets and themes:
45
53
 
46
54
  ```bash
47
55
  pip install ms_components
48
56
  ```
49
57
 
58
+ Choose the integrations your application uses, or install all of them:
59
+
60
+ ```bash
61
+ pip install "ms_components[table,pymol]"
62
+ pip install "ms_components[all]"
63
+ ```
64
+
65
+ | Extra | Dependency / use |
66
+ | --- | --- |
67
+ | `table` | SQLModel tables |
68
+ | `monitor` | Pydantic monitor configuration |
69
+ | `projects` | `ms_flow` project catalog and standalone project browser |
70
+ | `pymol` | `pymol-open-source` alpha wheels (`>=3.2.0a0`) |
71
+ | `steps` | `ms_env` provisioning steps |
72
+ | `dev` | All integrations and pytest |
73
+
74
+ Extras select dependencies; all component source files remain in the package.
75
+ Project widgets accept a supplied backend without importing `ms_flow`. When no backend is
76
+ supplied, they use the optional MolSuite catalog, which creates its database on first use.
77
+ Run the standalone browser with `python -m ms_components.ms_projects.app` after installing
78
+ `ms_components[projects]`.
79
+
50
80
  ## Documentation
51
81
 
52
82
  <https://molsuite.github.io/ms_components/>: a guide to each component, examples,
@@ -0,0 +1,50 @@
1
+ # ms_components
2
+
3
+ PySide6 UI components for MolSuite: smart table, project browser, job monitor,
4
+ PyMOL dock, steppers and the shared theming (`themes/` + `base.qss`).
5
+
6
+ [`ms_tutorial`](docs/ms_tutorial.md) provides informative and interactive tours:
7
+ Python binds existing widgets/signals, while content can be defined in Python or
8
+ TOML. Try `PYTHONPATH=src python examples/tutorial_demo.py` from a source checkout.
9
+
10
+ Part of the [MolSuite](https://molsuite.github.io/) stack. The project catalog integrates
11
+ with [`ms_flow`](https://github.com/MolSuite/ms_flow) when that backend is needed.
12
+
13
+ ## Install
14
+
15
+ The base installation provides Qt widgets and themes:
16
+
17
+ ```bash
18
+ pip install ms_components
19
+ ```
20
+
21
+ Choose the integrations your application uses, or install all of them:
22
+
23
+ ```bash
24
+ pip install "ms_components[table,pymol]"
25
+ pip install "ms_components[all]"
26
+ ```
27
+
28
+ | Extra | Dependency / use |
29
+ | --- | --- |
30
+ | `table` | SQLModel tables |
31
+ | `monitor` | Pydantic monitor configuration |
32
+ | `projects` | `ms_flow` project catalog and standalone project browser |
33
+ | `pymol` | `pymol-open-source` alpha wheels (`>=3.2.0a0`) |
34
+ | `steps` | `ms_env` provisioning steps |
35
+ | `dev` | All integrations and pytest |
36
+
37
+ Extras select dependencies; all component source files remain in the package.
38
+ Project widgets accept a supplied backend without importing `ms_flow`. When no backend is
39
+ supplied, they use the optional MolSuite catalog, which creates its database on first use.
40
+ Run the standalone browser with `python -m ms_components.ms_projects.app` after installing
41
+ `ms_components[projects]`.
42
+
43
+ ## Documentation
44
+
45
+ <https://molsuite.github.io/ms_components/>: a guide to each component, examples,
46
+ and the API reference.
47
+
48
+ ## License
49
+
50
+ MIT — see [LICENSE](LICENSE). Third-party icon/asset licenses live in `licenses/`.
@@ -0,0 +1,24 @@
1
+ qt-themes — https://github.com/beatreichenbach/qt-themes
2
+ Palette values in src/ms_components/theme.py are derived from this project.
3
+
4
+ MIT License
5
+
6
+ Copyright (c) 2024 Beat Reichenbach
7
+
8
+ Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ of this software and associated documentation files (the "Software"), to deal
10
+ in the Software without restriction, including without limitation the rights
11
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ copies of the Software, and to permit persons to whom the Software is
13
+ furnished to do so, subject to the following conditions:
14
+
15
+ The above copyright notice and this permission notice shall be included in all
16
+ copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24
+ SOFTWARE.
@@ -24,18 +24,20 @@ classifiers = [
24
24
  "Environment :: X11 Applications :: Qt",
25
25
  ]
26
26
 
27
- # UI components sit on top of the orchestrator (molsuite_flow), Qt and PyMOL.
27
+ # Shared widgets need Qt; each integration declares its own dependencies below.
28
28
  dependencies = [
29
- "ms_env>=0.2.0",
30
- "ms_flow>=0.2.0",
31
29
  "PySide6>=6.5",
32
- "pymol-open-source>=3.2.0a0",
33
- "sqlmodel>=0.0.14",
34
30
  ]
35
31
 
36
32
  [project.optional-dependencies]
33
+ monitor = ["pydantic>=2.0"]
34
+ projects = ["ms_flow>=0.2.0"]
35
+ pymol = ["pymol-open-source>=3.2.0a0"]
36
+ steps = ["ms_env>=0.2.0"]
37
+ table = ["sqlmodel>=0.0.14"]
38
+ all = ["ms_components[monitor,projects,pymol,steps,table]"]
37
39
  # Test + development tooling.
38
- dev = ["pytest>=7.0"]
40
+ dev = ["ms_components[all]", "pytest>=7.0"]
39
41
 
40
42
  [project.urls]
41
43
  Homepage = "https://github.com/MolSuite/ms_components"
@@ -0,0 +1,156 @@
1
+ """Draw or edit a small molecule in Ketcher (EPAM's web editor), embedded in a QWebEngineView.
2
+
3
+ `folder` is an unpacked Ketcher standalone build (the folder holding its index.html); the
4
+ application installs it. Ketcher's JS API answers with Promises, which runJavaScript cannot
5
+ await: the settled value is parked in a window variable and polled from here.
6
+
7
+ `run_editor` opens the dialog in its own process (`python -m ms_components.ketcher`): in an
8
+ application's process, PySide 6.10 segfaults as soon as the pointer hovers a QWebEngineView
9
+ while any Python application-wide event filter is installed. It also keeps Chromium's memory
10
+ and GPU use away from the rest of the application (an embedded PyMOL, for one)."""
11
+ from __future__ import annotations
12
+
13
+ import json
14
+ import subprocess
15
+ import sys
16
+ import tempfile
17
+ from collections.abc import Callable
18
+ from pathlib import Path
19
+
20
+ from PySide6.QtCore import QCoreApplication, Qt, QTimer, QUrl, QUrlQuery
21
+ from PySide6.QtWidgets import QApplication, QDialog, QDialogButtonBox, QLabel, QMessageBox, QVBoxLayout
22
+
23
+ # Resolves once Ketcher has built `window.ketcher`, some time after the page itself loads.
24
+ _READY = "new Promise(r => { const t = setInterval(() => { if (window.ketcher) { clearInterval(t); r(true); } }, 100); })"
25
+
26
+ # Ketcher 3.18 standalone's URL options configure the editor before it mounts.
27
+ _HIDDEN_CONTROLS = (
28
+ "open", "save", "arrows", "reaction-plus", "reaction-mapping-tools", "reaction-map", "reaction-unmap",
29
+ "rgroup", "rgroup-label", "rgroup-fragment", "rgroup-attpoints", "sgroup", "create-monomer",
30
+ "shapes", "shape-ellipse", "shape-rectangle", "shape-line", "text", "images",
31
+ "recognize", "analyse", "miew", "settings", "help", "about", "fullscreen",
32
+ )
33
+
34
+
35
+ class KetcherDialog(QDialog):
36
+ """Ketcher opened on `molblock`; after exec() == Accepted, `molblock` holds the drawing.
37
+ `note` is shown under the editor (e.g. what Apply will do)."""
38
+
39
+ def __init__(self, folder: Path, molblock: str, *, title: str, note: str = "", parent=None):
40
+ from PySide6.QtWebEngineWidgets import QWebEngineView # heavy: only when someone edits
41
+
42
+ super().__init__(parent)
43
+ self.setWindowTitle(title)
44
+ self.resize(1100, 750)
45
+ self.molblock = molblock
46
+ self._done: Callable[[dict], None] | None = None
47
+ self._poll = QTimer(self, interval=100)
48
+ # As JSON: a JS object comes back to Python empty, a string intact.
49
+ self._poll.timeout.connect(
50
+ lambda: self._view.page().runJavaScript("JSON.stringify(window.__ketcher ?? null)", 0, self._polled)
51
+ )
52
+
53
+ self._view = QWebEngineView(self)
54
+ self._view.loadFinished.connect(self._loaded)
55
+ url = QUrl.fromLocalFile(str(Path(folder) / "index.html"))
56
+ query = QUrlQuery()
57
+ query.addQueryItem("hiddenControls", ",".join(_HIDDEN_CONTROLS))
58
+ query.addQueryItem("disableMacromoleculesEditor", "true") # initialize without waiting for macromolecules
59
+ url.setQuery(query)
60
+ self._view.load(url)
61
+ self._buttons = QDialogButtonBox(QDialogButtonBox.StandardButton.Apply | QDialogButtonBox.StandardButton.Cancel, self)
62
+ self._buttons.button(QDialogButtonBox.StandardButton.Apply).clicked.connect(self._apply)
63
+ self._buttons.button(QDialogButtonBox.StandardButton.Apply).setEnabled(False)
64
+ self._buttons.rejected.connect(self.reject)
65
+ layout = QVBoxLayout(self)
66
+ layout.addWidget(self._view, 1)
67
+ if note:
68
+ label = QLabel(note, self)
69
+ label.setWordWrap(True)
70
+ layout.addWidget(label)
71
+ layout.addWidget(self._buttons)
72
+
73
+ def _call(self, promise: str, done: Callable[[dict], None]) -> None:
74
+ """Evaluate a JS Promise; `done({"ok": value} | {"error": text})` once it settles."""
75
+ self._done = done
76
+ self._view.page().runJavaScript(
77
+ "window.__ketcher = undefined;"
78
+ f"Promise.resolve({promise}).then(v => window.__ketcher = {{ok: v ?? ''}},"
79
+ " e => window.__ketcher = {error: String(e)});"
80
+ )
81
+ self._poll.start()
82
+
83
+ def _polled(self, value) -> None:
84
+ result = json.loads(value or "null")
85
+ if not result or self._done is None:
86
+ return
87
+ self._poll.stop()
88
+ done, self._done = self._done, None
89
+ done(result)
90
+
91
+ def _loaded(self, ok: bool) -> None:
92
+ if not ok:
93
+ QMessageBox.critical(self, "Ketcher", "Ketcher could not be loaded.")
94
+ return
95
+ self._call(f"{_READY}.then(() => window.ketcher.setMolecule({json.dumps(self.molblock)}))", self._ready)
96
+
97
+ def _ready(self, result: dict) -> None:
98
+ if "error" in result:
99
+ QMessageBox.warning(self, "Ketcher", f"Ketcher could not open the molecule:\n{result['error']}")
100
+ return
101
+ self._buttons.button(QDialogButtonBox.StandardButton.Apply).setEnabled(True)
102
+
103
+ def _apply(self) -> None:
104
+ self._buttons.setEnabled(False)
105
+ self._call("window.ketcher.getMolfile()", self._got)
106
+
107
+ def _got(self, result: dict) -> None:
108
+ self._buttons.setEnabled(True)
109
+ if "error" in result:
110
+ QMessageBox.critical(self, "Ketcher", f"Could not read the drawing:\n{result['error']}")
111
+ return
112
+ self.molblock = str(result.get("ok") or "")
113
+ self.accept()
114
+
115
+
116
+ def run_editor(
117
+ folder: Path,
118
+ molblock: str,
119
+ title: str,
120
+ *,
121
+ note: str = "",
122
+ theme: str = "auto",
123
+ base_font_pt: float | None = None,
124
+ ) -> str | None:
125
+ """Open a KetcherDialog in a child process and wait; the drawing after Apply, None on Cancel.
126
+ Blocking: call it off the GUI thread. `theme`/`base_font_pt` go to ms_components.theme."""
127
+ options = {"folder": str(folder), "title": title, "note": note, "theme": theme, "base_font_pt": base_font_pt}
128
+ with tempfile.TemporaryDirectory() as tmp:
129
+ out = Path(tmp) / "edited.mol"
130
+ proc = subprocess.run(
131
+ [sys.executable, "-m", __name__, json.dumps(options), str(out)],
132
+ input=molblock, capture_output=True, text=True,
133
+ )
134
+ if proc.returncode != 0:
135
+ raise RuntimeError(f"The editor stopped (exit code {proc.returncode}):\n{proc.stderr[-2000:]}")
136
+ return out.read_text() if out.exists() else None
137
+
138
+
139
+ def _main(options: str, out: str) -> int:
140
+ """The child process: molblock on stdin; the drawing is written to `out` only on Apply."""
141
+ from ms_components.theme import apply_theme
142
+
143
+ opts = json.loads(options)
144
+ QCoreApplication.setAttribute(Qt.ApplicationAttribute.AA_ShareOpenGLContexts) # QtWebEngine wants it before the app
145
+ app = QApplication(["ms-ketcher"])
146
+ apply_theme(opts.get("theme") or "auto", app, base_font_pt=opts.get("base_font_pt"))
147
+ dialog = KetcherDialog(Path(opts["folder"]), sys.stdin.read(), title=opts["title"], note=opts.get("note", ""))
148
+ if dialog.exec() == QDialog.DialogCode.Accepted:
149
+ Path(out).write_text(dialog.molblock)
150
+ return 0
151
+
152
+
153
+ __all__ = ["KetcherDialog", "run_editor"]
154
+
155
+ if __name__ == "__main__":
156
+ sys.exit(_main(*sys.argv[1:3]))
@@ -0,0 +1,4 @@
1
+ from .browser import ProjectBrowserPanel, ProjectBrowserWindow, ProjectFormDialog
2
+ from .widget import ProjectsMenuWidget
3
+
4
+ __all__ = ["ProjectBrowserPanel", "ProjectBrowserWindow", "ProjectFormDialog", "ProjectsMenuWidget"]
@@ -2,14 +2,20 @@ from __future__ import annotations
2
2
 
3
3
  import sys
4
4
 
5
- from PySide6.QtWidgets import QApplication
5
+ from PySide6.QtWidgets import QApplication, QMessageBox
6
6
 
7
7
  from ms_components.ms_projects.browser import ProjectBrowserWindow
8
8
 
9
9
 
10
10
  def main(argv: list[str] | None = None) -> int:
11
11
  app = QApplication(list(sys.argv[1:] if argv is None else argv))
12
- window = ProjectBrowserWindow()
12
+ try:
13
+ window = ProjectBrowserWindow()
14
+ except ModuleNotFoundError as exc:
15
+ if exc.name != "ms_flow":
16
+ raise
17
+ QMessageBox.critical(None, "Projects", str(exc))
18
+ return 1
13
19
  window.show()
14
20
  return app.exec()
15
21
 
@@ -0,0 +1,15 @@
1
+ """Load MolSuite's default catalog only when a caller has not supplied a backend."""
2
+ from __future__ import annotations
3
+
4
+
5
+ def create_catalog_backend(*, app_id_filter: str | None = None):
6
+ try:
7
+ from ms_flow.core.project.catalog import ProjectCatalogBackend
8
+ except ModuleNotFoundError as exc:
9
+ if exc.name != "ms_flow":
10
+ raise
11
+ raise ModuleNotFoundError(
12
+ 'The project catalog requires ms_flow. Install it with: pip install "ms_components[projects]"',
13
+ name="ms_flow",
14
+ ) from exc
15
+ return ProjectCatalogBackend(app_id_filter=app_id_filter)
@@ -3,7 +3,7 @@ from __future__ import annotations
3
3
  import sys
4
4
  from dataclasses import dataclass, field
5
5
  from pathlib import Path
6
- from typing import Any, List, Optional
6
+ from typing import TYPE_CHECKING, Any, List, Optional
7
7
 
8
8
  from PySide6.QtCore import (
9
9
  Qt, Signal, QRect, QSize, QAbstractTableModel, QModelIndex, QEvent,
@@ -21,11 +21,14 @@ from PySide6.QtWidgets import (
21
21
  QTreeView, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget,
22
22
  )
23
23
 
24
- from ms_flow.core.project.catalog import ProjectCatalogBackend
25
- from ms_flow.core.settings.manager import SettingsManager
26
- from ms_flow.core.settings.models import Settings
24
+ from ms_components.ms_projects.backend import create_catalog_backend
27
25
  from ms_components.theme import color as theme_color
28
26
 
27
+ if TYPE_CHECKING:
28
+ from ms_flow.core.project.catalog import ProjectCatalogBackend
29
+ from ms_flow.core.settings.manager import SettingsManager
30
+ from ms_flow.core.settings.models import Settings
31
+
29
32
 
30
33
  # ── Palette ───────────────────────────────────────────────────────────────────
31
34
  _TOOL_COLORS: list[str] = [
@@ -988,6 +991,9 @@ class StatsDialog(QDialog):
988
991
 
989
992
 
990
993
  class ProjectFormDialog(QDialog):
994
+ name_committed = Signal(str)
995
+ path_selected = Signal(str)
996
+
991
997
  def __init__(self, *, apps: list, mode: str,
992
998
  initial_data: dict | None = None,
993
999
  allow_app_selection: bool = True, parent=None):
@@ -1005,6 +1011,7 @@ class ProjectFormDialog(QDialog):
1005
1011
  layout = QVBoxLayout(self)
1006
1012
  form = QFormLayout()
1007
1013
  self.name_input = QLineEdit(self.initial_data.get("name", ""))
1014
+ self.name_input.editingFinished.connect(lambda: self.name_committed.emit(self.name_input.text().strip()))
1008
1015
  self.path_input = QLineEdit(str(self.initial_data.get("path", "")))
1009
1016
  self.path_input.setReadOnly(True)
1010
1017
  self.description_input = QTextEdit(self.initial_data.get("description", ""))
@@ -1022,11 +1029,11 @@ class ProjectFormDialog(QDialog):
1022
1029
  idx = self.app_combo.findData(cid)
1023
1030
  if idx >= 0: self.app_combo.setCurrentIndex(idx)
1024
1031
  self.app_combo.setEnabled(self.allow_app_selection and not is_edit)
1025
- path_row = QWidget()
1032
+ path_row = self.path_row = QWidget()
1026
1033
  pl = QHBoxLayout(path_row)
1027
1034
  pl.setContentsMargins(0,0,0,0)
1028
1035
  pl.addWidget(self.path_input)
1029
- browse_btn = QPushButton("Browse...")
1036
+ browse_btn = self.browse_button = QPushButton("Browse...")
1030
1037
  browse_btn.clicked.connect(self._on_browse)
1031
1038
  browse_btn.setEnabled(not is_edit)
1032
1039
  pl.addWidget(browse_btn)
@@ -1037,6 +1044,7 @@ class ProjectFormDialog(QDialog):
1037
1044
  form.addRow("Description:", self.description_input)
1038
1045
  layout.addLayout(form)
1039
1046
  btns = QDialogButtonBox(QDialogButtonBox.Save | QDialogButtonBox.Cancel)
1047
+ self.save_button = btns.button(QDialogButtonBox.Save)
1040
1048
  btns.accepted.connect(self.accept)
1041
1049
  btns.rejected.connect(self.reject)
1042
1050
  layout.addWidget(btns)
@@ -1045,7 +1053,9 @@ class ProjectFormDialog(QDialog):
1045
1053
  folder = QFileDialog.getExistingDirectory(
1046
1054
  self, "Select folder",
1047
1055
  self.path_input.text().strip() or str(Path.home()))
1048
- if folder: self.path_input.setText(folder)
1056
+ if folder:
1057
+ self.path_input.setText(folder)
1058
+ self.path_selected.emit(folder)
1049
1059
 
1050
1060
  def accept(self):
1051
1061
  if not self.name_input.text().strip():
@@ -1091,6 +1101,7 @@ class StatTile(QFrame):
1091
1101
  class ProjectBrowserPanel(QWidget):
1092
1102
  project_requested = Signal(str)
1093
1103
  project_created = Signal(str)
1104
+ project_form_opened = Signal(object)
1094
1105
  projects_changed = Signal()
1095
1106
 
1096
1107
  def __init__(self, *, app_id: str | None = None, header_title: str,
@@ -1100,7 +1111,7 @@ class ProjectBrowserPanel(QWidget):
1100
1111
  _backend: ProjectCatalogBackend | None = None, parent=None):
1101
1112
  super().__init__(parent)
1102
1113
  self.app_id = (app_id or "").strip() or None
1103
- self.backend = _backend or ProjectCatalogBackend(app_id_filter=None)
1114
+ self.backend = _backend if _backend is not None else create_catalog_backend()
1104
1115
  self.header_title = header_title
1105
1116
  self.hint_text = hint_text
1106
1117
  self.allow_app_selection = (
@@ -1288,6 +1299,7 @@ class ProjectBrowserPanel(QWidget):
1288
1299
  "description": raw.description, "tags": raw.tags,
1289
1300
  "app_id": raw.app_id},
1290
1301
  allow_app_selection=self._dialog_allows_app_selection(), parent=self)
1302
+ self.project_form_opened.emit(dlg)
1291
1303
  if dlg.exec() != QDialog.Accepted:
1292
1304
  return
1293
1305
  data = dlg.get_data()
@@ -1355,6 +1367,7 @@ class ProjectBrowserPanel(QWidget):
1355
1367
  initial_data={"path": str(Path.home()/"molsuite_projects"),
1356
1368
  "app_id": self._active_tool_app_id or apps[0].app_id},
1357
1369
  allow_app_selection=self._dialog_allows_app_selection(), parent=self)
1370
+ self.project_form_opened.emit(dlg)
1358
1371
  if dlg.exec() != QDialog.Accepted:
1359
1372
  return
1360
1373
  fd = dlg.get_data()
@@ -1992,7 +2005,7 @@ class ProjectBrowserWindow(QMainWindow):
1992
2005
  close_on_launch: bool = True, _backend: ProjectCatalogBackend | None = None):
1993
2006
  super().__init__()
1994
2007
  self.app_id = (app_id or "").strip() or None
1995
- self.backend = _backend or ProjectCatalogBackend(app_id_filter=None)
2008
+ self.backend = _backend if _backend is not None else create_catalog_backend()
1996
2009
  self.window_title = window_title or "MolSuite Control Center"
1997
2010
  self.close_on_launch = close_on_launch
1998
2011
  eff_header = header_title or (self.app_id or "MolSuite Projects")
@@ -2072,7 +2085,6 @@ class ProjectBrowserWindow(QMainWindow):
2072
2085
 
2073
2086
 
2074
2087
  if __name__ == "__main__":
2075
- app = QApplication(sys.argv[1:])
2076
- w = ProjectBrowserWindow()
2077
- w.show()
2078
- sys.exit(app.exec())
2088
+ from ms_components.ms_projects.app import main
2089
+
2090
+ sys.exit(main())
@@ -1,7 +1,7 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  from pathlib import Path
4
- from typing import Optional
4
+ from typing import TYPE_CHECKING, Optional
5
5
 
6
6
  from PySide6.QtCore import Qt, Signal
7
7
  from PySide6.QtWidgets import (
@@ -16,9 +16,12 @@ from PySide6.QtWidgets import (
16
16
  QWidget,
17
17
  )
18
18
 
19
- from ms_flow.core.project.catalog import ProjectCatalogBackend
19
+ from ms_components.ms_projects.backend import create_catalog_backend
20
20
  from ms_components.ms_projects.browser import ProjectFormDialog, ProjectItem, ProjectTreeWidget
21
21
 
22
+ if TYPE_CHECKING:
23
+ from ms_flow.core.project.catalog import ProjectCatalogBackend
24
+
22
25
  _PROJECT_MENU_COLORS = [
23
26
  "#4e95ff",
24
27
  "#a259ff",
@@ -38,6 +41,7 @@ def _project_color(index: int) -> str:
38
41
  class ProjectsMenuWidget(QFrame):
39
42
  project_requested = Signal(str)
40
43
  project_created = Signal(str)
44
+ project_form_opened = Signal(object)
41
45
  # The host app's open project was confirmed for deletion: the host closes it, then deletes it.
42
46
  active_project_delete_requested = Signal(str)
43
47
 
@@ -55,7 +59,7 @@ class ProjectsMenuWidget(QFrame):
55
59
  ):
56
60
  super().__init__(parent)
57
61
  self.app_id = (app_id or "").strip() or None
58
- self.backend = backend or ProjectCatalogBackend(app_id_filter=self.app_id)
62
+ self.backend = backend if backend is not None else create_catalog_backend(app_id_filter=self.app_id)
59
63
  self.title = title
60
64
  self.hint_text = hint_text
61
65
  self.allow_create = allow_create
@@ -173,6 +177,7 @@ class ProjectsMenuWidget(QFrame):
173
177
  allow_app_selection=self.allow_app_selection,
174
178
  parent=self,
175
179
  )
180
+ self.project_form_opened.emit(dialog)
176
181
  if dialog.exec() != ProjectFormDialog.Accepted:
177
182
  return
178
183
  data = dialog.get_data()
@@ -224,6 +229,7 @@ class ProjectsMenuWidget(QFrame):
224
229
  allow_app_selection=False,
225
230
  parent=self,
226
231
  )
232
+ self.project_form_opened.emit(dialog)
227
233
  if dialog.exec() != ProjectFormDialog.Accepted:
228
234
  return
229
235
  data = dialog.get_data()
@@ -0,0 +1,49 @@
1
+ from .scene import (
2
+ SceneMemory,
3
+ add_scene_actions,
4
+ clear_scene,
5
+ color_atoms,
6
+ color_by_residue_nature,
7
+ frame,
8
+ install_scene_memory,
9
+ is_additive,
10
+ is_interacting,
11
+ menu_action,
12
+ object_list,
13
+ prepare_scene,
14
+ select_atoms,
15
+ set_additive,
16
+ set_scene_context,
17
+ )
18
+ from .widget import (
19
+ COMPARISON_COLORS,
20
+ associate_scene_objects,
21
+ PymolControlBar,
22
+ PymolDockWidget,
23
+ PymolPresetSpec,
24
+ PymolSceneContext,
25
+ )
26
+
27
+ __all__ = [
28
+ "COMPARISON_COLORS",
29
+ "SceneMemory",
30
+ "add_scene_actions",
31
+ "associate_scene_objects",
32
+ "clear_scene",
33
+ "color_atoms",
34
+ "color_by_residue_nature",
35
+ "frame",
36
+ "install_scene_memory",
37
+ "is_additive",
38
+ "is_interacting",
39
+ "menu_action",
40
+ "object_list",
41
+ "prepare_scene",
42
+ "select_atoms",
43
+ "set_additive",
44
+ "set_scene_context",
45
+ "PymolControlBar",
46
+ "PymolDockWidget",
47
+ "PymolPresetSpec",
48
+ "PymolSceneContext",
49
+ ]
@@ -0,0 +1 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-paintbrush-icon lucide-paintbrush"><path d="m14.622 17.897-10.68-2.913"/><path d="M18.376 2.622a1 1 0 1 1 3.002 3.002L17.36 9.643a.5.5 0 0 0 0 .707l.944.944a2.41 2.41 0 0 1 0 3.408l-.944.944a.5.5 0 0 1-.707 0L8.354 7.348a.5.5 0 0 1 0-.707l.944-.944a2.41 2.41 0 0 1 3.408 0l.944.944a.5.5 0 0 0 .707 0z"/><path d="M9 8c-1.804 2.71-3.97 3.46-6.583 3.948a.507.507 0 0 0-.302.819l7.32 8.883a1 1 0 0 0 1.185.204C12.735 20.405 16 16.792 16 15"/></svg>