Migrate setup.py to pyproject.toml

Author: Cito

.github/workflows/test-package.yml

@@ -25,7 +25,7 @@ jobs:
     - name: Lint with flake8
       if: matrix.python-version == '3.11'
       run: |
-        flake8 webware setup.py --count --exit-zero --statistics
+        flake8 webware --count --exit-zero --statistics
     - name: Lint with pylint
       if: matrix.python-version == '3.11'
       run: |

docs/conf.py

@@ -26,9 +26,9 @@
 author = 'Christoph Zwerschke et al.'
 
 # The short X.Y version
-version = '3.0'
+version = '3.1'
 # The full version, including alpha/beta/rc tags
-release = '3.0.10'
+release = '3.1.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/install.rst

@@ -53,22 +53,24 @@ When installing Webware for Python 3, the following "extras" can optionally be i
 
 * "dev": extras for developing Webware applications
 * "examples": extras for running all Webware examples
-* "test": extras needed to test all functions of Webware
+* "tests": extras needed to test all functions of Webware
 * "docs": extras needed to build this documentation
 
-On your development machine, we recommend installing the full "test" environment which also includes the other two environments. To do that, you need to specify the "Extras" name in square brackets when installing Webware for Python 3::
+On your development machine, we recommend installing the full "tests" environment which also includes the other two environments. To do that, you need to specify the "Extras" name in square brackets when installing Webware for Python 3::
 
-    pip install "Webware-for-Python[dev]>=3"
+    pip install "Webware-for-Python[tests]>=3"
 
 
 Installation from Source
 ------------------------
 
-Alternatively, you can also download_ Webware for Python 3 from PyPI, and run the ``setup.py`` command in the tar.gz archive like this::
+Alternatively, you can also download_ Webware for Python 3 from PyPI, and run::
 
-    setup.py install
+    python -m pip install .
 
-You will then have to also install the "extra" requirements manually, though. Have a look at the setup.py file to see the list of required packages.
+Or, to create an editable installation with the extras for testing::
+
+    python -m pip install -e .[tests]
 
 .. _download: https://pypi.org/project/Webware-for-Python/
 

docs/overview.rst

@@ -32,7 +32,7 @@ Design Points and Changes
 
 Another key goal of the original project was to provide a "Pythonic" API, instead of simply copying Java APIs. However, the project was created when Python 2 was still in its infancy, lacking many modern features and conventions such as PEP-8. Therefore, the Webware for Python API is a bit different from what is considered "Pythonic" nowadays. Particularly, it uses getters and setters instead of properties (but without the "get" prefix for getters), and camelCase method names instead of snake_case. In order to facilitate migration of existing projects, Webware for Python 3 kept this old API, even though it is not in line with PEP-8 and could be simplified by using properties. Modernizing the API will be a goal for a possible third edition of Webware for Python, as well as using the Python logging facility which did not yet exist when Webware for Python was created and is still done via printing to the standard output.
 
-The plug-in architecture has also been kept in Webware for Python 3, but now implemented in a more modern way using entry points for discovering plug-ins. Old plug-ins are not compatible, but can be adapted quite easily. The old Webware for Python installer has been replaced by a standard setup.py based installation.
+The plug-in architecture has also been kept in Webware for Python 3, but now implemented in a more modern way using entry points for discovering plug-ins. Old plug-ins are not compatible, but can be adapted quite easily. The old Webware for Python installer has been replaced by a standard setup.py and later pyproject.toml based installation.
 
 The most incisive change in Webware for Python 3 is the discontinuation of the threaded application server that was part of the built-in "WebKit" plug-in and actually one of the strong-points of Webware for Python. However, a threaded application based architecture may not be the best option anymore for Python in the age of multi-core processors due to the global interpreter lock (`GIL`_), and maintaining the application server based architecture would have also meant to maintain the various adapters such as ``mod_webkit`` and the start scripts for the application server for various operating systems. This did not appear to be feasible. At the same time, Python nowadays already provides a standardized way for web frameworks to deploy web applications with the Python Web Server Gateway Interface (`WSGI`_). By making the already existing Application class of Webware for Python usable as a WSGI application object, Webware applications can now be deployed in a standardized way using any WSGI compliant web server, and the necessity for operating as an application server itself has been removed. Webware for Python 3 applications deployed using ``mod_wsgi`` are even performing better and can be scaled in more ways than applications for the original Webware for Python that have been deployed using ``mod_webkit`` which used to be the deployment option with the best performance. During development, the waitress_ WSGI server is used to serve the application, replacing the old built-in HTTP server. As a structural simplification that goes along with the removal of the WebKit application server, the contents of the WebKit plug-in are now available at the top level of Webware for Python 3, and WebKit ceased to exist as a separate plug-in.
 

docs/plugins.rst

@@ -9,7 +9,7 @@ In Webware for Python 3, plug-ins are implemented as packages with metadata ("en
 
 Every Webware plug-in is a Python package, i.e. a directory that contains a ``__init__.py`` file and optionally other files. As a Webware plugin, it must also contain a special ``Properties.py`` file. You can disable a specific plug-in by placing a ``dontload`` file in its package directory.
 
-If you want to distribute a Webware plug-in, you should advertize it as an entry point using the ``webware.plugins`` identifier in the ``setup.py`` file used to install the plug-in.
+If you want to distribute a Webware plug-in, you should advertize it as an entry point using the ``webware.plugins`` identifier in the ``pyproject.toml`` file used to install the plug-in.
 
 The ``__init.py__`` file of the plug-in must contain at least a function like this::
 

docs/testing.rst

@@ -11,7 +11,7 @@ Testing Webware itself
 
 The unit tests and end to end tests for Webware for Python can be found in the ``Tests`` subdirectories of the root ``webware`` package and its plug-ins. Webware also has a built-in context ``Testing`` that contains some special servlets for testing various functionality of Webware, which can be invoked manually, but will also be tested automatically as part of the end-to-end tests.
 
-Before running the test suite, install Webware for Python into a virtual environment and activate that environment. While developing and testing Webware, it is recommended to install Webware in editable mode. To do this, unpack the source installation package of Webware for Python 3, and run this command in the directory containing the ``setup.py`` file::
+Before running the test suite, install Webware for Python into a virtual environment and activate that environment. While developing and testing Webware, it is recommended to install Webware in editable mode. To do this, unpack the source installation package of Webware for Python 3, and run this command in the directory containing the ``pyproject.toml`` file::
 
     pip install -e .[tests]
 

pyproject.toml

@@ -0,0 +1,93 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "Webware-for-Python"
+# must match webware.Properties.version and docs.conf.release
+version = "3.1.0"
+description = "Webware for Python is a time-tested modular, object-oriented web framework."
+authors = [
+    {name = "Christoph Zwerschke et al.", email = "cito@online.de"},
+]
+readme = "README.md"
+keywords = ["web", "framework", "servlets"]
+license = {text = "MIT"}
+# must match properties.requiredPyVersion
+requires-python = ">=3.6"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://webwareforpython.github.io/w4py3/"
+Source = "https://github.com/WebwareForPython/w4py3"
+Issues = "https://github.com/WebwareForPython/w4py3/issues"
+Documentation = "https://webwareforpython.github.io/w4py3/"
+
+[project.optional-dependencies]
+dev = [
+    "Pygments>=2.14,<3",
+    "WebTest>=3,<4",
+    "waitress>=2,<3",
+    "hupper>=1.10,<2",
+]
+docs = [
+    "Sphinx>=5,<7",
+    "sphinx_rtd_theme>=1.1",
+]
+examples = [
+    "DBUtils>=3,<4",
+    "dominate>=2.7,<3",
+    "yattag>=1.15,<2",
+    "Pygments>=2.14,<3",
+    "Pillow>=8,<12",
+]
+tests = [
+    "psutil>=5.9,<7",
+    "flake8>=5,<7",
+    "pylint>=2.13,<3",
+    "tox>=3.28,<5",
+    "pywin32>=300,<400; sys_platform=='win32' and implementation_name=='cpython'",
+    # include dev dependencies
+    "Pygments>=2.14,<3",
+    "WebTest>=3,<4",
+    "waitress>=2,<3",
+    "hupper>=1.10,<2",
+    # include example dependencies
+    "DBUtils>=3,<4",
+    "dominate>=2.7,<3",
+    "yattag>=1.15,<2",
+    "Pillow>=8,<12",
+]
+
+[project.scripts]
+webware = "webware.Scripts.WebwareCLI:main"
+
+[project.entry-points."webware.plugins"]
+MiscUtils = "webware.MiscUtils"
+PSP = "webware.PSP"
+TaskKit = "webware.TaskKit"
+UserKit = "webware.UserKit"
+WebUtils = "webware.WebUtils"
+
+[tool.setuptools]
+include-package-data = true

setup.py

@@ -5,7 +5,7 @@ envlist = py{36,37,38,39,310,311,312}, pypy3, flake8, pylint, docs, manifest
 basepython = python3.11
 deps = flake8>=6,<7
 commands =
-    flake8 webware setup.py
+    flake8 webware
 
 [testenv:pylint]
 basepython = python3.11

tox.ini

@@ -1,4 +1,4 @@
-import pkg_resources
+from importlib.metadata import entry_points
 
 from PlugIn import PlugIn
 
@@ -46,7 +46,7 @@ def loadPlugIns(self, plugInNames=None, verbose=None):
 
         entryPoints = {
             entry_point.name: entry_point for entry_point
-            in pkg_resources.iter_entry_points('webware.plugins')}
+            in entry_points(group='webware.plugins')}
 
         plugIns = {}
         for name in plugInNames: