Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation instruction on README #797

Merged
merged 2 commits into from
Nov 10, 2020

Conversation

kitchoi
Copy link
Contributor

@kitchoi kitchoi commented Nov 10, 2020

This PR updates the README for Pyface (also visible on PyPI page) to provide installation instructions for optional dependencies.

Copy link
Contributor

@rahulporuri rahulporuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

README.rst Outdated

$ pip install pyface[pyqt5]

To install with wxPython dependencies (experimental)::
Copy link
Contributor

@corranwebster corranwebster Nov 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should specify wxPython 4?

@codecov-io
Copy link

codecov-io commented Nov 10, 2020

Codecov Report

Merging #797 (7e0774b) into master (4bccc3e) will increase coverage by 0.21%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #797      +/-   ##
==========================================
+ Coverage   40.67%   40.88%   +0.21%     
==========================================
  Files         508      508              
  Lines       27832    27832              
  Branches     4217     4217              
==========================================
+ Hits        11320    11379      +59     
+ Misses      16016    15979      -37     
+ Partials      496      474      -22     
Impacted Files Coverage Δ
pyface/ui/qt4/tasks/split_editor_area_pane.py 65.41% <0.00%> (+0.59%) ⬆️
pyface/ui/qt4/console/console_widget.py 29.28% <0.00%> (+0.72%) ⬆️
pyface/ui/qt4/tasks/advanced_editor_area_pane.py 51.72% <0.00%> (+0.86%) ⬆️
pyface/wx/python_stc.py 10.36% <0.00%> (+1.21%) ⬆️
pyface/ui/qt4/tasks/task_window_backend.py 60.52% <0.00%> (+1.31%) ⬆️
pyface/ui/qt4/code_editor/code_widget.py 44.39% <0.00%> (+1.69%) ⬆️
pyface/ui/qt4/tasks/editor_area_pane.py 55.88% <0.00%> (+2.20%) ⬆️
pyface/ui/qt4/application_window.py 91.66% <0.00%> (+2.38%) ⬆️
pyface/ui/qt4/util/gui_test_assistant.py 80.53% <0.00%> (+2.65%) ⬆️
pyface/ui/qt4/window.py 73.87% <0.00%> (+2.70%) ⬆️
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4bccc3e...7e0774b. Read the comment docs.

will run tests in all supported environments automatically.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah... I tried to change 'wxPython' to 'wxPython4' via GitHub directly and GitHub did this change for me!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds the missing newline at the end of file, and I am going to merge away...

@kitchoi kitchoi merged commit bb51b65 into master Nov 10, 2020
@kitchoi kitchoi deleted the expand-readme-install-instruction branch November 10, 2020 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants