Documented new QtPy requirement

Author: PierreRaybaut

README.md

@@ -45,6 +45,7 @@ Application development tools:
 - Python 2.6+ or Python 3.2+
 - [PyQt4](https://pypi.python.org/pypi/PyQt4) 4.3+ or [PyQt5](https://pypi.python.org/pypi/PyQt5) 5.5+
 - [spyder](https://pypi.python.org/pypi/spyder) 2.1+ (test launcher and array/dictionnary editors)
+- [QtPy](https://pypi.org/project/QtPy/) >= 1.3
 
 ### Optional Python modules
 

doc/installation.rst

@@ -8,6 +8,7 @@ Requirements:
 
     * Python 2.x (x>=6) or 3.x (x>=2)
     * `PyQt4`_ 4.x (x>=3 ; recommended x>=4) or `PyQt5`_ 5.x (x>=5)
+    * `QtPy`_ >= 1.3
 
 Optional Python modules:
 
@@ -17,6 +18,7 @@ Optional Python modules:
 
 .. _PyQt4: https://pypi.python.org/pypi/PyQt4
 .. _PyQt5: https://pypi.python.org/pypi/PyQt5
+.. _qtpy: https://pypi.org/project/QtPy/
 .. _spyder: https://pypi.python.org/pypi/Spyder
 .. _h5py: https://pypi.python.org/pypi/h5py
 .. _cx_Freeze: https://pypi.python.org/pypi/cx_Freeze

setup.py

@@ -34,11 +34,13 @@
 from guidata.utils import get_subpackages, get_package_data
 
 
-LIBNAME = 'guidata'
+LIBNAME = "guidata"
 from guidata import __version__ as version
 
-DESCRIPTION = 'Automatic graphical user interfaces generation for easy '\
-              'dataset editing and display'
+DESCRIPTION = (
+    "Automatic graphical user interfaces generation for easy "
+    "dataset editing and display"
+)
 LONG_DESCRIPTION = """\
 guidata: Automatic GUI generation for easy dataset editing and display with Python
 ======================================================================================
@@ -95,76 +97,83 @@
 
 .. _README: https://github.com/PierreRaybaut/guidata/blob/master/README.md"""
 
-KEYWORDS = ''
-CLASSIFIERS = ['Topic :: Scientific/Engineering']
-if 'beta' in version or 'b' in version:
-    CLASSIFIERS += ['Development Status :: 4 - Beta']
-elif 'alpha' in version or 'a' in version:
-    CLASSIFIERS += ['Development Status :: 3 - Alpha']
+KEYWORDS = ""
+CLASSIFIERS = ["Topic :: Scientific/Engineering"]
+if "beta" in version or "b" in version:
+    CLASSIFIERS += ["Development Status :: 4 - Beta"]
+elif "alpha" in version or "a" in version:
+    CLASSIFIERS += ["Development Status :: 3 - Alpha"]
 else:
-    CLASSIFIERS += ['Development Status :: 5 - Production/Stable']
+    CLASSIFIERS += ["Development Status :: 5 - Production/Stable"]
 
 
 def build_chm_doc(libname):
     """Return CHM documentation file (on Windows only), which is copied under 
     {PythonInstallDir}\Doc, hence allowing Spyder to add an entry for opening 
     package documentation in "Help" menu. This has no effect on a source 
     distribution."""
-    args = ''.join(sys.argv)
-    if os.name == 'nt' and ('bdist' in args or 'build' in args):
+    args = "".join(sys.argv)
+    if os.name == "nt" and ("bdist" in args or "build" in args):
         try:
             import sphinx  # analysis:ignore
         except ImportError:
-            print('Warning: `sphinx` is required to build documentation',
-                  file=sys.stderr)
+            print(
+                "Warning: `sphinx` is required to build documentation", file=sys.stderr
+            )
             return
-        hhc_base = r'C:\Program Files%s\HTML Help Workshop\hhc.exe'
-        for hhc_exe in (hhc_base % '', hhc_base % ' (x86)'):
+        hhc_base = r"C:\Program Files%s\HTML Help Workshop\hhc.exe"
+        for hhc_exe in (hhc_base % "", hhc_base % " (x86)"):
             if osp.isfile(hhc_exe):
                 break
         else:
-            print('Warning: `HTML Help Workshop` is required to build CHM '\
-                  'documentation file', file=sys.stderr)
+            print(
+                "Warning: `HTML Help Workshop` is required to build CHM "
+                "documentation file",
+                file=sys.stderr,
+            )
             return
-        doctmp_dir = 'doctmp'
-        subprocess.call('sphinx-build -b htmlhelp doc %s' % doctmp_dir,
-                        shell=True)
+        doctmp_dir = "doctmp"
+        subprocess.call("sphinx-build -b htmlhelp doc %s" % doctmp_dir, shell=True)
         atexit.register(shutil.rmtree, osp.abspath(doctmp_dir))
-        fname = osp.abspath(osp.join(doctmp_dir, '%s.chm' % libname))
+        fname = osp.abspath(osp.join(doctmp_dir, "%s.chm" % libname))
         subprocess.call('"%s" %s' % (hhc_exe, fname), shell=True)
         if osp.isfile(fname):
             return fname
         else:
-            print('Warning: CHM building process failed', file=sys.stderr)
+            print("Warning: CHM building process failed", file=sys.stderr)
+
 
 CHM_DOC = build_chm_doc(LIBNAME)
 
 
-setup(name=LIBNAME, version=version,
-      description=DESCRIPTION, long_description=LONG_DESCRIPTION,
-      packages=get_subpackages(LIBNAME),
-      package_data={LIBNAME:
-                    get_package_data(LIBNAME, ('.png', '.svg', '.mo'))},
-      data_files=[(r'Doc', [CHM_DOC])] if CHM_DOC else [],
-      install_requires=["QtPy"],
-      entry_points={'gui_scripts':
-                    ['guidata-tests-py%d = guidata.tests:run'\
-                     % sys.version_info.major,]},
-      extras_require = {
-                        'Doc':  ["Sphinx>=1.1"],
-                        },
-      author = "Pierre Raybaut",
-      author_email = '[email protected]',
-      url = 'https://github.com/PierreRaybaut/%s' % LIBNAME,
-      license = 'CeCILL V2',
-      classifiers=CLASSIFIERS + [
-        'Operating System :: MacOS',
-        'Operating System :: Microsoft :: Windows',
-        'Operating System :: OS Independent',
-        'Operating System :: POSIX',
-        'Operating System :: Unix',
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        ],
-      )
+setup(
+    name=LIBNAME,
+    version=version,
+    description=DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
+    packages=get_subpackages(LIBNAME),
+    package_data={LIBNAME: get_package_data(LIBNAME, (".png", ".svg", ".mo"))},
+    data_files=[(r"Doc", [CHM_DOC])] if CHM_DOC else [],
+    install_requires=["QtPy>=1.3"],
+    entry_points={
+        "gui_scripts": [
+            "guidata-tests-py%d = guidata.tests:run" % sys.version_info.major,
+        ]
+    },
+    extras_require={"Doc": ["Sphinx>=1.1"],},
+    author="Pierre Raybaut",
+    author_email="[email protected]",
+    url="https://github.com/PierreRaybaut/%s" % LIBNAME,
+    license="CeCILL V2",
+    classifiers=CLASSIFIERS
+    + [
+        "Operating System :: MacOS",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: OS Independent",
+        "Operating System :: POSIX",
+        "Operating System :: Unix",
+        "Programming Language :: Python :: 2.6",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3",
+    ],
+)