packaging: modernize packaging

- Replace pbr with setuptools, setuptools_scm, and build.
- Move most of the packaging settings into pyproject.toml.
- Update tox settings to reflect packaging changes.
- Update documentation build version detection.
- Update documentation for entry points now that setup.cfg is removed.

Fixes #33
Addresses #34

Author: dhellmann

docs/source/conf.py

@@ -13,7 +13,7 @@
 # serve to show the default.
 
 import datetime
-import subprocess
+import importlib.metadata
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -51,11 +51,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = subprocess.check_output([
-    'sh', '-c',
-    'cd ../..; python setup.py --version',
-]).decode('utf-8')
-version = version.strip()
+version = importlib.metadata.version('virtualenvwrapper')
 # The full version, including alpha/beta/rc tags.
 release = version
 

docs/source/plugins.rst

@@ -162,25 +162,30 @@ Registering Entry Points
 
 The functions defined in the plugin need to be registered as *entry
 points* in order for virtualenvwrapper's hook loader to find them.
-Entry points are configured in the ``setup.py`` (or ``setup.cfg`` when
-using pbr) for your package by mapping the entry point name to the
-function in the package that implements it.
+Entry points are configured in the packaging instructions for your
+package by mapping the entry point name to the function in the package
+that implements it.
 
-This partial copy of virtualenvwrapper's ``setup.cfg`` illustrates how
+This partial copy of virtualenvwrapper's ``pyproject.toml`` illustrates how
 the ``initialize()`` and ``initialize_source()`` entry points are
 configured.
 
-.. include:: ../../setup.cfg
-   :literal:
-   :start-after: [entry_points]
+::
+
+    [project.entry-points."virtualenvwrapper.initialize"]
+    user_scripts = "virtualenvwrapper.user_scripts:initialize"
+    project = "virtualenvwrapper.project:initialize"
+
+    [project.entry-points."virtualenvwrapper.initialize_source"]
+    user_scripts = "virtualenvwrapper.user_scripts:initialize_source"
 
-The ``entry_points`` section maps the *group names* to lists of entry
+Each entry points section maps the *group names* to lists of entry
 point specifiers.  A different group name is defined by
 virtualenvwrapper for each extension point (see
 :ref:`plugins-extension-points`).
 
 The entry point specifiers are strings with the syntax ``name =
-package.module:function``.  By convention, the *name* of each entry
+"package.module:function"``.  By convention, the *name* of each entry
 point is the plugin name, but that is not required (the names are not
 used).
 

pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["setuptools", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+authors = [
+  {name = "Doug Hellmann", email = "[email protected]"},
+  {name = "Jason Myers", email = "[email protected]"},
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Intended Audience :: Developers",
+    "Environment :: Console",
+]
+
+name = "virtualenvwrapper"
+description = ""
+dynamic = ["version"]
+keywords = ["virtualenv"]
+license = {text = "MIT"}
+readme = "README.txt"
+requires-python = ">=3.8"
+
+dependencies = [
+    "virtualenv",
+    "virtualenv-clone",
+    "stevedore",
+]
+
+# https://github.com/pypa/setuptools_scm/
+[tool.setuptools_scm]
+
+[project.urls]
+homepage = "https://virtualenvwrapper.readthedocs.io/"
+repository = "https://github.com/python-virtualenvwrapper/virtualenvwrapper"
+
+[project.entry-points."virtualenvwrapper.initialize"]
+user_scripts = "virtualenvwrapper.user_scripts:initialize"
+project = "virtualenvwrapper.project:initialize"
+
+[project.entry-points."virtualenvwrapper.initialize_source"]
+user_scripts = "virtualenvwrapper.user_scripts:initialize_source"
+
+[project.entry-points."virtualenvwrapper.pre_mkvirtualenv"]
+user_scripts = "virtualenvwrapper.user_scripts:pre_mkvirtualenv"
+
+[project.entry-points."virtualenvwrapper.post_mkvirtualenv_source"]
+user_scripts = "virtualenvwrapper.user_scripts:post_mkvirtualenv_source"
+
+[project.entry-points."virtualenvwrapper.pre_cpvirtualenv"]
+user_scripts = "virtualenvwrapper.user_scripts:pre_cpvirtualenv"
+
+[project.entry-points."virtualenvwrapper.post_cpvirtualenv_source"]
+user_scripts = "virtualenvwrapper.user_scripts:post_cpvirtualenv_source"
+
+[project.entry-points."virtualenvwrapper.pre_rmvirtualenv"]
+user_scripts = "virtualenvwrapper.user_scripts:pre_rmvirtualenv"
+
+[project.entry-points."virtualenvwrapper.post_rmvirtualenv"]
+user_scripts = "virtualenvwrapper.user_scripts:post_rmvirtualenv"
+
+[project.entry-points."virtualenvwrapper.project.pre_mkproject"]
+project = "virtualenvwrapper.project:pre_mkproject"
+
+[project.entry-points."virtualenvwrapper.project.post_mkproject_source"]
+project = "virtualenvwrapper.project:post_mkproject_source"
+
+[project.entry-points."virtualenvwrapper.pre_activate"]
+user_scripts = "virtualenvwrapper.user_scripts:pre_activate"
+
+[project.entry-points."virtualenvwrapper.post_activate_source"]
+project = "virtualenvwrapper.project:post_activate_source"
+user_scripts = "virtualenvwrapper.user_scripts:post_activate_source"
+
+[project.entry-points."virtualenvwrapper.pre_deactivate_source"]
+user_scripts = "virtualenvwrapper.user_scripts:pre_deactivate_source"
+
+[project.entry-points."virtualenvwrapper.post_deactivate_source"]
+user_scripts = "virtualenvwrapper.user_scripts:post_deactivate_source"
+
+[project.entry-points."virtualenvwrapper.get_env_details"]
+user_scripts = "virtualenvwrapper.user_scripts:get_env_details"

requirements.txt

@@ -3,6 +3,10 @@
 from setuptools import setup
 
 setup(
-    setup_requires=['pbr'],
-    pbr=True,
+    # Listing the scripts in pyproject.toml requires them to be python
+    # entry points for console scripts, but they are shell scripts.
+    scripts=[
+        "virtualenvwrapper.sh",
+        "virtualenvwrapper_lazy.sh",
+    ],
 )

setup.cfg

@@ -2,9 +2,7 @@
 envlist = py,zsh,style
 
 [testenv]
-install_command = pip install -U {opts} {packages}
 commands = bash ./tests/run_tests {envdir} []
-deps = -rrequirements.txt
 pass_env =
     HOME
     USER
@@ -33,18 +31,17 @@ commands =  zsh -o shwordsplit ./tests/run_tests {envdir} []
 
 [testenv:docs]
 deps =
-  -r{toxinidir}/requirements.txt
   -r{toxinidir}/docs/requirements.txt
 commands =
     sphinx-build -W -j auto -b html -d docs/build/doctrees docs/source docs/build/html
     sphinx-build -W -j auto -b linkcheck -d docs/build/doctrees docs/source docs/build/linkcheck
 
 [testenv:pkglint]
 deps=
-    pbr
+    build
     twine
     check-python-versions
 commands=
-    python setup.py sdist
+    python -m build
     twine check dist/*.tar.gz
-    check-python-versions --only setup.py,setup.cfg,.github/workflows/test.yml
+    check-python-versions --only pyproject.toml,.github/workflows/test.yml