diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index a1dd0a8e..0de52b4f 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -59,10 +59,6 @@ jobs: sudo apt-get install libxcb-render-util0 sudo apt-get install libxcb-xinerama0 - - name: Install Dependencies - run: | - pip install pyqt5 PyQtWebEngine - - name: Install HyperSpy (dev) shell: bash if: ${{ contains(matrix.HYPERSPY_VERSION, 'dev') }} @@ -72,7 +68,7 @@ jobs: - name: Install shell: bash run: | - pip install -e .[tests] + pip install -e .[all,tests] - name: Pip list run: | diff --git a/README.rst b/README.rst index 9d34315b..5f9eef80 100644 --- a/README.rst +++ b/README.rst @@ -69,18 +69,18 @@ and run the following command in the anaconda prompt: Installation via pip -------------------- -HyperSpyUI can be intall from pip. Depending on your python distribution you may -need to have C compiler on your system to install some of the dependencies. +To install ``HyperSpyUI`` can be intalled from pypi.org including +optional dependencies (``exspy`` and ``pyqt5``) .. code-block:: bash - pip install hyperspyui + pip install hyperspyui[all] -If pyqt is not installed, run: +To install ``HyperSpyUI`` with the minimum dependencies: .. code-block:: bash - pip install PyQt5 PyQtWebEngine + pip install hyperspyui Run HyperSpyUI diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 5ce979b5..06138626 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -36,8 +36,7 @@ HyperSpyUI is on PyPI_, so simply run the command .. code-block:: bash - pip install PyQt5 PyQtWebEngine - pip install hyperspyui + pip install hyperspyui[all] which will download and install HyperSpyUI and its dependencies. The package defines diff --git a/pyproject.toml b/pyproject.toml index 1ebc69db..7ef954f1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -59,6 +59,10 @@ hyperspyui = "hyperspyui.__main__:main" file = "COPYING.txt" [project.optional-dependencies] +"all" = [ + "exspy", + "hyperspyui[pyqt]", +] "doc" = [ "sphinx > 5.2", "sphinx_rtd_theme", @@ -66,16 +70,16 @@ file = "COPYING.txt" "sphinxcontrib-towncrier", "towncrier", ] +"pyqt" = [ + "PyQt5", + "PyQtWebEngine", +] "tests" = [ "pytest-qt", "pytest-cov", "pytest-timeout", "setuptools-scm", ] -"all" = [ - "exspy[gui-jupyter]", - "exspy[gui-traitsui]" -] [project.urls] "Homepage" = "https://hyperspy.org/hyperspyui" diff --git a/upcoming_changes/252.enhancements.rst b/upcoming_changes/252.enhancements.rst new file mode 100644 index 00000000..2f1edcd3 --- /dev/null +++ b/upcoming_changes/252.enhancements.rst @@ -0,0 +1 @@ +Add ``pyqt`` pip extra to simplify installation. \ No newline at end of file