jetperch / pyjoulescope_ui

Joulescope graphical user interface
https://www.joulescope.com
Apache License 2.0
87 stars 26 forks source link

doc: update readme #121

Closed sophiekovalevsky closed 3 years ago

sophiekovalevsky commented 3 years ago

Hi @mliberty1, thanks for creating this amazing project.

I would like to do some modifications in the quick tutorial if someone needs to run the ui from source.

I couldn't run first python3 -m joulescope_ui cause I found out that there are some python files to be generated from qrc and ui.

This is one messages that I got:

return original_import(name, *args, **kwargs)
ModuleNotFoundError: No module named 'joulescope_ui.error_window'

The issue dissapears when I prepare the tar file:

⇒ python3 setup.py sdist
running sdist
Generate joulescope_ui/error_window.py
Generate joulescope_ui/preferences_dialog.py
Generate joulescope_ui/export_dialog.py
Generate joulescope_ui/widgets/gpio/gpio_widget_ui.py
Generate joulescope_ui/widgets/single_value/single_value_widget_dev.py
Generate joulescope_ui/widgets/uart/uart_config_widget.py
Generate joulescope_ui/widgets/uart/uart_widget.py
Generate joulescope_ui/plugins/histogram_config_widget.py
Generate joulescope_ui/plugins/cdf_config_widget.py
Generate joulescope_ui/plugins/max_window_config_widget.py
Generate joulescope_ui/resources.rcc
Generate joulescope_ui/fonts.rcc
running egg_info
creating joulescope_ui.egg-info
writing joulescope_ui.egg-info/PKG-INFO
writing dependency_links to joulescope_ui.egg-info/dependency_links.txt
writing entry points to joulescope_ui.egg-info/entry_points.txt
writing requirements to joulescope_ui.egg-info/requires.txt
writing top-level names to joulescope_ui.egg-info/top_level.txt
writing manifest file 'joulescope_ui.egg-info/SOURCES.txt'
reading manifest file 'joulescope_ui.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'joulescope_ui.egg-info/SOURCES.txt'
running check
........
Writing joulescope_ui-0.9.3/setup.cfg
creating dist
Creating tar archive
removing 'joulescope_ui-0.9.3' (and everything under it)

Being write that, I would suggest to swap the steps along with a tiny typo when trying to install the package, instead of python install use pip install

It looks like while adding the changes, git adds or my IDE adds some extra spaces. Let me know if I need to change that.

Thanks,