Merge ppa-dev-tools:packaging-drop-setup-py into ppa-dev-tools:main

[Bryce Harrington]

Updates the packaging to resolve some deprecation warnings.

The bug that prompted this is LP: #2055636, and I believe this should resolve that issue by finishing the move away from setup.py, but am not sure how to 100% repro their installation approach. However, it does fix the deprecation issues I'm aware of when following the "SOURCE" section in INSTALL.md. I've not tested this exhaustively yet so there could well be a few more adjustments needed.

This also resolves the older LP: #1989617 by using the `build` packaging system with setuptools. I looked at `hatch` and `poetry` but didn't spot advantages to them that I'd need, and `build` feels like it will be more supportable on Ubuntu systems.

[Mitchell Dzurick (mitchdz)]

comment inline

[Bryce Harrington (bryce)]

Thanks Mitchell, that was a good note. I did reproduce that issue on noble too, and I've been tinkering with different installation techniques, and trying to research into best practices. The latter didn't reveal anything amazing, but with the former I've found that using '--no-deps' seems to achieve the goal I was going for (installing the package with dependencies satisfied by only distro-provided packages). See if that works for you.

I'm also tempted to add a 'make install' target that hides the mechanics and have the INSTALL directions reduce to just 'make build; sudo make install'. Totally doable, but I consider that most people are not going to be installing that way but rather using the PPA package, the snap, or pip. So people who *do* install this way will by definition be wanting a more flexible and hands-on approach so knowing the options may be more interesting. Open to more ideas/opinions on this.

I've also added python3-build and python3-pip as dependencies in the INSTALL docs, since testing in a raw LXC container seemed to need them. But I'm not 100% sure they are, so would also appreciate a doublecheck on that.

[Athos Ribeiro (athos-ribeiro)]

Thanks, Bryce!

This looks good. I do have a couple comments inline below.

[Bryce Harrington (bryce)]

Thanks for the feedback, I've updated with the suggested changes.

[Mitchell Dzurick (mitchdz)]

`python3 -m pip install --no-deps .` still produces the issue in my noble VM. The issue ultimately is because of the following doc: https://packaging.python.org/en/latest/specifications/externally-managed-environments/#externally-managed-environments .

Ultimately the "proper" fix for this is to use a venv:

python3 -m venv .venv
source .venv/bin/activate
pip install .

But that doesn't install it system-wide of course.

Anyways, I think it is fine to keep as-is due to most people will be consuming this package from the snap. Anyone doing it manually should understand the consequences and add that flag. Just add a note in INSTALL.md that you may see it.

[Mitchell Dzurick (mitchdz)]

review: Approve

[Athos Ribeiro (athos-ribeiro)]

My personal workflow is also `virtualenv` oriented TBH (although I use an additional abstraction layer through mkvirtualenv). This is how I usually test, review, and use ppa-dev-tools.

The most interesting bit here is to balance between using development dependencies from the archive or from the system (we know pypi does not have all the needed dependencies).

Since this is designed to be used with the archive's dependencies, I suppose a future improvement would be to have a test matrix to test the package with the runtime dependencies of each supported Ubuntu release.

This is already a great improvement though and definitely LGTM!

review: Approve

[Bryce Harrington (bryce)]

Thanks for the reviews!

In thinking about this a bit more, the reason I'm partial to documenting how to install without PIP is less about ease use but to facilitate packaging this into a deb for the PPA, to catch any dependencies (or versions) that wouldn't be available from the archive.

However, that doesn't mean that additional directions couldn't be included, after all the INSTALL doc is already a catalog of different approaches, why not include one more if users are actually using it?

So, I'd like to include the venv+pip-based approach, perhaps either in the PIP section or right after it. However, I'm curious how you two are doing your test installations, since for me it appears to be not pulling in the dependencies properly. So far I've got this for documentation:

"""
Or to install from the source checkout locally with PIP-provided
dependencies in a virtual environment:

  $ python3 -m venv .venv
  $ source .venv/bin/activate
  (.venv)$ pip install addict distro_info lazr lazr.restfulclient ruamel.yaml yapf
  (.venv)$ pip install .
  (.venv)$ ppa --version
  ppa 0.5.0
"""

However, this still complains about missing the apt_pkg dependency. More importantly though, why is this not automatically detecting the dependencies? Have I broken it by removing setup.py, or is there an extra step missing?

I'll go ahead and land this branch as-is without this, and then add this once it's working for me.

[Athos Ribeiro (athos-ribeiro)]

Hi Bryce, I usually go for virtual environments for most python projects I work with, this included. Since some of the dependencies are not available through PyPI, as you already pointed out, I install a virtual environment with access to my system's installed python packages.

The following should be enough to get it up to a functional states and with tests passing:

$ mkvirtualenv --system-site-packages ppa-dev-tools
$ pip install -r requirements-dev.txt
$ pip install -e .
$ pip install mock
$ python -m pytest tests
$ ppa --help

Note that I had to install mock manually (probably missing from the dev requirements).

Also, note that the current Makefile is not fully compatible with virtual environments given how the binaries are being called.

To Stop using the virtual environment:
$ deactivate

To enable (and then disable it again:
$ workon ppa-dev-tools
$ deactivate

diff --git a/INSTALL.md b/INSTALL.md
index e1fd232..03d61cd 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -48,19 +48,19 @@ On Ubuntu 20.04 and similar systems, prerequisites can be satisfied from
 the apt repository:
 
   $ sudo apt-get install \
+      python3-build \
       python3-appdirs \
       python3-debian \
       python3-distro-info \
       python3-launchpadlib \
       python3-lazr.restfulclient \
-      python3-setuptools \
       python3-software-properties \
-      python3-yaml
+      python3-yaml \
+      python3-pip
 
-Installation follows the usual python conventions:
+Installation is performed as follows:
 
-  $ python3 ./setup.py check
-  $ python3 ./setup.py build
-  $ sudo python3 ./setup.py install
+  $ python3 -m build --no-isolation
+  $ sudo python3 -m pip install --no-deps .
   $ ppa --version
   ppa 0.5.0
diff --git a/TESTING.md b/TESTING.md
index a81966e..6e1e80e 100644
--- a/TESTING.md
+++ b/TESTING.md
@@ -2,9 +2,18 @@
 
 For running the testsuite:
 
-$ sudo apt install -y python3-pytest python3-mock
+$ sudo apt install -y \
+      python3-pytest \
+      python3-mock \
+      python3-flake8 \
+      python3-coverage
 
 
 ## Testing
 
-$ python3 setup.py check
+$ make check
+
+or
+
+$ pytest-3
+
diff --git a/pyproject.toml b/pyproject.toml
index 3b1ce9a..d4efadb 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -2,6 +2,14 @@
 requires = ["setuptools >= 40.6.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools]
+script-files = ["scripts/ppa"]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["ppa"]
+exclude = ["snap", "debian"]
+
 [tool.towncrier]
 filename = "CHANGELOG.md"
 package = "ppa-dev-tools"
@@ -31,4 +39,4 @@ classifiers = [
 
 [project.urls]
 "Homepage" = "https://launchpad.net/ppa-dev-tools"
-"Bug Tracker" = "https://bugs.launchpad.net/ppa-dev-tools"
\ No newline at end of file
+"Bug Tracker" = "https://bugs.launchpad.net/ppa-dev-tools"
diff --git a/setup.py b/setup.py
deleted file mode 100755
index 2f1dee0..0000000
--- a/setup.py
+++ /dev/null
@@ -1,67 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-# ppa - Tools for creating, installing, modifying, and testing PPAs.
-#
-# Copyright (c) 2012,2019-2022 - Bryce W. Harrington
-
-from setuptools import setup, find_packages
-
-import sys
-import re
-
-if sys.version_info < (3,0):
-    sys.exit('Please run setup.py with python3')
-
-def get_version(package):
-    """Directly retrieve version, avoiding an import.
-
-    Since setup.py runs before the package is set up, we can't expect
-    that simply doing an import ._version will work reliably in all
-    cases.  Instead, manually import the version from the file here,
-    and then the module can be imported elsewhere in the project easily.
-    """
-    version_file = "%s/%s" %(package, '_version.py')
-    version_string = open(version_file, "rt").read()
-    re_version = r"^__version__ = ['\"]([^'\"]*)['\"]"
-    m = re.search(re_version, version_string, re.M)
-    if not m:
-        raise RuntimeError("Unable to find version string for %s in %s." %(
-            package, version_file))
-    return m.group(1)
-
-def get_description():
-    return open('README.md', 'rt').read()
-
-setup(
-    name             = 'ppa-dev-tools',
-    version          = get_version('ppa'),
-    url              = 'https://launchpad.net/ppa-dev-tools',
-    author           = 'Bryce W. Harrington',
-    author_email     = '[e-mail]',
-    description      = 'Utility for interacting with PPAs on Launchpad',
-    long_description = get_description(),
-    classifiers      = [
-        # See https://pypi.org/pypi?%3Aaction=list_classifiers
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Information Technology',
-        'Topic :: Software Development :: Build Tools',
-        'Topic :: System :: Archiving :: Packaging',
-        'Topic :: System :: Software Distribution',
-        'License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)',
-        'Programming Language :: Python :: 3',
-        ],
-    platforms        = ['any'],
-    python_requires  = '>=3',
-    setup_requires   = [
-        'pytest-runner'
-        ],
-    tests_require    = [
-        'pytest'
-        ],
-    install_requires = [],  # See INSTALL.md
-    scripts          = ['scripts/ppa'],
-    packages         = find_packages(),
-    package_data     = { },
-    data_files       = [ ],
-)
diff --git a/tox.ini b/tox.ini
index 5e56ea0..58fa3a8 100644
--- a/tox.ini
+++ b/tox.ini
@@ -2,26 +2,28 @@
 envlist = flake8, pylint, pytest
 recreate = true
 skipsdist = true
+sitepackages = True
 
 [testenv:flake8]
 deps =
     flake8
     flake8-docstrings
-commands = flake8 ppa tests setup.py
+commands = flake8 ppa tests
 
 [testenv:pylint]
 deps =
     pylint
     pytest
 commands =
-    pylint --max-line-length=100 ppa tests setup.py
+    pylint --max-line-length=100 ppa tests
 
 [testenv:pytest]
 deps =
     pytest
     pytest-cov
+    mock
 commands =
-    py.test --cov ppa tests
+    python3 -m pytest --cov ppa tests
 
 [flake8]
 max-line-length = 100