README image + version check issues (#32)

Author: RobPasMue

.gitignore

@@ -78,6 +78,7 @@ instance/
 
 # Sphinx documentation
 doc/_build/
+doc/source/images
 
 # PyBuilder
 .pybuilder/

.pre-commit-config.yaml

@@ -1,5 +1,3 @@
-fail_fast: True
-
 repos:
 
 - repo: https://github.com/pycqa/isort
@@ -18,7 +16,7 @@ repos:
   rev: 1.13.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==22.12.0]
+    additional_dependencies: [black==23.1.0]
 
 - repo: https://github.com/PyCQA/flake8
   rev: 6.0.0
@@ -32,12 +30,12 @@ repos:
     args: ["--toml", "pyproject.toml"]
     additional_dependencies: ["tomli"]
 
-# - repo: https://github.com/pycqa/pydocstyle
-#   rev: 6.1.1
-#   hooks:
-#   - id: pydocstyle
-#     additional_dependencies: [toml]
-#     exclude: "tests/"
+- repo: https://github.com/pycqa/pydocstyle
+  rev: 6.3.0
+  hooks:
+  - id: pydocstyle
+    additional_dependencies: [toml]
+    exclude: "tests/"
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.4.0

README.rst

@@ -4,6 +4,8 @@ Ansys Python Installer (QT)
 This is a simple cross-platform `QT <https://www.qt.io/>`_ application
 you can use to install Python and (optional) PyAnsys packages.
 
+.. image:: images/app-image.png
+   :alt: Screenshot of Python Installer application
 
 Installation
 ~~~~~~~~~~~~

doc/Makefile

@@ -23,6 +23,7 @@ help:
 clean:
 	rm -rf $(BUILDDIR)/*
 	rm -rf $(SOURCEDIR)/examples
+	rm -rf $(SOURCEDIR)/images
 	find . -type d -name "_autosummary" -exec rm -rf {} +
 
 # Create PDF

doc/make.bat

@@ -32,6 +32,8 @@ goto end
 
 :clean
 rmdir /s /q %BUILDDIR% > /NUL 2>&1 
+rmdir /s /q %SOURCEDIR%\examples > /NUL 2>&1 
+rmdir /s /q %SOURCEDIR%\images > /NUL 2>&1 
 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
 goto end
 

doc/source/conf.py

@@ -1,5 +1,6 @@
 """Sphinx documentation configuration file."""
 from datetime import datetime
+import shutil
 
 from ansys_sphinx_theme import pyansys_logo_black as logo
 
@@ -48,7 +49,7 @@
 }
 
 # static path
-html_static_path = ["_static"]
+html_static_path = ["_static", "images"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -58,3 +59,6 @@
 
 # The master toctree document.
 master_doc = "index"
+
+# Copying README images
+shutil.copytree("../../images", "images", dirs_exist_ok=True)

images/app-image.png

@@ -1,6 +1,5 @@
-"""
-Ansys Python Manager
-"""
+"""Ansys Python Manager."""
+
 import os
 import sys
 import warnings

src/ansys/tools/installer/__init__.py

@@ -1,6 +1,4 @@
-"""
-Check for updates.
-"""
+"""Check for updates."""
 
 from github import Github
 from packaging import version

src/ansys/tools/installer/auto_updater.py

@@ -1,3 +1,5 @@
+"""Common module for Ansys Python Manager."""
+
 from functools import wraps
 import logging
 import sys
@@ -9,7 +11,7 @@
 
 
 def threaded(fn):
-    """Call a function using a thread"""
+    """Call a function using a thread."""
 
     def wrapper(*args, **kwargs):
         thread = Thread(target=fn, args=args, kwargs=kwargs)
@@ -20,7 +22,7 @@ def wrapper(*args, **kwargs):
 
 
 def protected(fn):
-    """Captures any exceptions from a function and passes it to the gui.
+    """Capture any exceptions from a function and pass it to the GUI.
 
     Attempts to display the error using ``show_error`` and protects
     the main application from segmentation faulting.

src/ansys/tools/installer/common.py

@@ -1,7 +1,5 @@
-"""
-Search for Python or miniforge installations within the Windows registry.
+"""Search for Python or miniforge installations within the Windows registry."""
 
-"""
 import logging
 import os
 
@@ -76,7 +74,6 @@ def _find_miniforge(admin=False):
 
 def _find_installed_python(admin=False):
     """Check the registry for any installed instances of Python."""
-
     if admin:
         root_key = winreg.HKEY_LOCAL_MACHINE
     else:

src/ansys/tools/installer/find_python.py

@@ -1,3 +1,5 @@
+"""Installed Python versions table module for Ansys Python Manager."""
+
 import logging
 import os
 import subprocess

src/ansys/tools/installer/installed_table.py

@@ -1,6 +1,5 @@
-"""
+"""Installer module for Ansys Python Manager."""
 
-"""
 import logging
 import subprocess
 

src/ansys/tools/installer/installer.py

@@ -1,4 +1,5 @@
 """Main installer window."""
+
 import logging
 from math import floor
 import os
@@ -51,6 +52,8 @@
 
 
 class AnsysPythonInstaller(QtWidgets.QMainWindow):
+    """Main Ansys Python Manager class."""
+
     signal_error = QtCore.Signal(str)
     signal_open_pbar = QtCore.Signal(int, str)
     signal_increment_pbar = QtCore.Signal()
@@ -59,6 +62,7 @@ class AnsysPythonInstaller(QtWidgets.QMainWindow):
     signal_close = QtCore.Signal()
 
     def __init__(self, show=True):
+        """Instantiate Ansys Python Manager main class."""
         super().__init__()
         self.setWindowTitle("Ansys Python Manager")
         self.setGeometry(50, 50, 500, 700)  # width should auto-update
@@ -179,11 +183,6 @@ def __init__(self, show=True):
         python_version_layout.setContentsMargins(0, 0, 0, 0)
         python_version.setLayout(python_version_layout)
 
-        # python_version_title = QtWidgets.QLabel("Python Version")
-        # python_version_layout.addWidget(python_version_title)
-
-        # python_version_text = QtWidgets.QLabel("Select one")
-
         self.python_version_select = QtWidgets.QComboBox()
         self.python_version_select.addItem("Python 3.7", "3.7.9")
         self.python_version_select.addItem("Python 3.8", "3.8.10")
@@ -249,19 +248,19 @@ def _close(self):
 
     @protected
     def check_for_updates(self):
+        """Check for Ansys Python Manager application updates."""
         LOG.debug("Checking for updates")
         (
             ver,
             url,
         ) = query_gh_latest_release()
         cur_ver = version.parse(__version__)
-        # if ver > cur_ver:
-        if True:
+        if ver > cur_ver:
             LOG.debug("Update available.")
             reply = QtWidgets.QMessageBox.question(
                 None,
                 "Update",
-                f"A new version {ver} is available. You are currently running version {cur_ver}. Do you want to update?",
+                f"The latest version available is {ver}. You are currently running version {cur_ver}. Do you want to update?",
                 QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No,
                 QtWidgets.QMessageBox.Yes,
             )
@@ -282,12 +281,14 @@ def check_for_updates(self):
             ).exec_()
 
     def visit_website(self):
+        """Access the Ansys Python Manager documentation."""
         url = QtCore.QUrl(
             "https://installer.docs.pyansys.com/version/dev/installer.html"
         )
         QtGui.QDesktopServices.openUrl(url)
 
     def show_about_dialog(self):
+        """Display the Ansys Python Manager 'About' information."""
         mbox = QtWidgets.QMessageBox.about(self, "About", ABOUT_TEXT)
 
     def _install_type_changed(self, *args):
@@ -316,7 +317,6 @@ def _pbar_increment(self):
     def pbar_open(self, nticks=5, label=""):
         """Open the progress bar.
 
-
         Parameters
         ----------
         nticks : int, default: 5
@@ -535,7 +535,6 @@ def _run_exe(self, filename):
 
 def open_gui():
     """Start the installer as a QT Application."""
-
     import argparse
     import ctypes
     import msvcrt

src/ansys/tools/installer/main.py

@@ -1,6 +1,4 @@
-"""
-Contains miscellaneous functionalities this library.
-"""
+"""Contains miscellaneous functionalities this library."""
 
 import logging
 import sys

src/ansys/tools/installer/misc.py

@@ -1,8 +1,13 @@
+"""Progress bar module for Ansys Python Manager."""
+
 from PySide6 import QtCore, QtWidgets
 
 
 class ProgressBar(QtWidgets.QDialog):
+    """ProgressBar class."""
+
     def __init__(self, parent, nticks, title="Progress Bar", label=None, show=True):
+        """Instantiate a ProgressBar object."""
         super().__init__(parent)
         self._pbar = QtWidgets.QProgressBar(self)
         self._pbar.setValue(0)