PyDMConverter 0.0.0__tar.gz → 1.0.2__tar.gz

{pydmconverter-0.0.0 → pydmconverter-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyDMConverter
-Version: 0.0.0
+Version: 1.0.2
 Summary: converter to generate pydm .ui files from other display managers.
 Author: Devan Agrawal, Zach Domke, Ryan McClanahan, Alexander Ng, Logan Somoza, Alexandria Ikuma
 Author-email: Yekta Yazar <yazar@slac.stanford.edu>

{pydmconverter-0.0.0 → pydmconverter-1.0.2}/PyDMConverter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyDMConverter
-Version: 0.0.0
+Version: 1.0.2
 Summary: converter to generate pydm .ui files from other display managers.
 Author: Devan Agrawal, Zach Domke, Ryan McClanahan, Alexander Ng, Logan Somoza, Alexandria Ikuma
 Author-email: Yekta Yazar <yazar@slac.stanford.edu>

{pydmconverter-0.0.0 → pydmconverter-1.0.2}/PyDMConverter.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@
 LICENSE
 README.md
 environment.yml
-launch_gui.sh
 mkdocs.yml
 pyproject.toml
 .github/ISSUE_TEMPLATE/bug-report.yml
@@ -55,6 +54,7 @@ examples/prosilica.edl
 pydmconverter/__init__.py
 pydmconverter/__main__.py
 pydmconverter/custom_types.py
+pydmconverter/launch_gui.sh
 pydmconverter/widgets.py
 pydmconverter/widgets_helpers.py
 pydmconverter/edm/__init__.py
@@ -64,6 +64,7 @@ pydmconverter/edm/menumux.py
 pydmconverter/edm/parser.py
 pydmconverter/edm/parser_helpers.py
 tests/__init__.py
+tests/test_main.py
 tests/test_widgets.py
 tests/test_widgets_helpers.py
 tests/edm/test_converter.py

{pydmconverter-0.0.0 → pydmconverter-1.0.2}/PyDMConverter.egg-info/top_level.txt

@@ -1 +1,2 @@
+app
 pydmconverter

pydmconverter-1.0.2/docs/user_guide.md

@@ -0,0 +1,73 @@
+#Installation
+
+##Prerequisites
+
+## Installation Methods
+
+### Option 1: Install from PyPI (Recommended)
+The easiest way to install the converter is directly from PyPI:
+``` bash
+pip install PyDMConverter
+```
+
+### Option 2: Install from Source
+If you need the latest development version or want to contribute:
+
+#### Clone the Repository
+``` bash
+git clone https://github.com/slaclab/pydm-converter-tool.git
+cd pydm-converter-tool
+```
+
+#### Set up Environment
+Using `conda`:
+``` bash
+conda env create -f environment.yml
+conda activate pydm
+```
+
+Or using pip:
+``` bash
+pip install -e .
+```
+
+# How to Run the Converter
+
+The converter can be run in two ways: via the command line interface (CLI) or through the graphical user interface (GUI).
+
+## Launch the GUI
+
+To launch the graphical interface:
+``` bash
+pydmconverter
+```
+
+This will open the PyDM Converter GUI where you can:
+- Select files or folders to convert
+
+## Command Line Interface
+
+The CLI provides two main ways to run the converter: on individual files and entire folders. Users can include additional arguments described on the [Arguments] page.
+
+  [Arguments]: arguments.md
+
+## For individual files
+When using the converter on a single file, the command line is:
+``` bash
+pydmconverter '/path/old_file.edl' 'new_file_name.ui' `
+```
+## For an entire folder
+When converting an entire folder, the command line is:
+``` bash
+pydmconverter '/path_to_old_directory' '/new_file_location' 'old_file_type'
+```
+
+## Examples
+To convert EDM file called "file.edl" to PYDM file called "file.ui" :
+``` bash
+pydmconverter /afs/slac/g/lcls/edm/file.edl file.ui`
+```
+To convert EDM files in a folder called "edm" to PYDM file in the current folder :
+``` bash
+pydmconverter /afs/slac/g/lcls/edm . .edl`
+```

{pydmconverter-0.0.0 → pydmconverter-1.0.2}/pydmconverter/__main__.py

@@ -17,8 +17,16 @@ def run_gui() -> None:
     """
     launch the PyDMConverter gui
     """
-    # subprocess.run(["pydm", "--hide-nav-bar", "--hide-menu-bar", "view/main_window.py"])
-    subprocess.run(["bash", "launch_gui.sh"], check=True)
+    # Get the directory where this package is installed
+    package_dir = Path(__file__).parent
+    launch_script = package_dir / "launch_gui.sh"
+
+    if not launch_script.exists():
+        raise FileNotFoundError(
+            f"launch_gui.sh not found at {launch_script}. Please ensure the package was installed correctly."
+        )
+
+    subprocess.run(["bash", str(launch_script)], check=True)
 
 
 def run(input_file, output_file, input_file_type=".edl", override=False, scrollable=False):

{pydmconverter-0.0.0 → pydmconverter-1.0.2}/pydmconverter/edm/converter.py

@@ -13,6 +13,7 @@ CUSTOM_WIDGET_DEFINITIONS = {
     "PyDMDrawingEllipse": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMDrawingLine": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMDrawingPolyline": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
+    "PyDMDrawingIrregularPolygon": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMLabel": {"extends": "QLabel", "header": "pydm.widgets.label", "container": ""},
     "PyDMEnumComboBox": {"extends": "QComboBox", "header": "pydm.widgets.enum_combo_box", "container": ""},
     "PyDMPushButton": {"extends": "QPushButton", "header": "pydm.widgets.pushbutton", "container": ""},
@@ -40,6 +41,7 @@ CUSTOM_WIDGET_DEFINITIONS = {
     "PyDMByteIndicator": {"extends": "QWidget", "header": "pydm.widgets.byte", "container": ""},
     "PyDMLineEdit": {"extends": "QLineEdit", "header": "pydm.widgets.line_edit", "container": ""},
     "PyDMDrawingArc": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
+    "PyDMDrawingPie": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMWaveformPlot": {"extends": "QWidget", "header": "pydm.widgets.waveformplot", "container": ""},
     "PyDMScaleIndicator": {"extends": "QWidget", "header": "pydm.widgets.scale", "container": ""},
     "PyDMShellCommand": {"extends": "QPushButton", "header": "pydm.widgets.shell_command", "container": ""},