Improve PyPI packaging

.gitignore

@@ -1,5 +1,5 @@
 *~
-*.pyc
+*.py[cod]
 *.exe
 *.asc
 venv*/
@@ -9,11 +9,16 @@ venv*/
 .coverage*
 reports/
 .scannerwork/
-packages/sshaudit/LICENSE
-packages/sshaudit/README.md
-packages/sshaudit/sshaudit.py
-packages/parts/
-packages/prime/
-packages/snap/
-packages/stage/
-packages/ssh-audit_*.snap
+
+# PyPI packaging
+/build/
+/dist/
+*.egg-info/
+*.egg
+
+# Snap packaging
+/parts/
+/prime/
+/snap/
+/stage/
+/ssh-audit_*.snap

Makefile.pypi

@@ -0,0 +1,11 @@
+all:
+	python3 setup.py sdist bdist_wheel
+
+uploadtest:
+	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+
+uploadprod:
+	twine upload dist/*
+
+clean:
+	rm -rf build/ dist/ src/*.egg-info/

packages/notes.txt → PACKAGING

@@ -7,7 +7,7 @@ $ virtualenv -p /usr/bin/python3 /tmp/pypi_upload
 $ cd /tmp/pypi_upload; source bin/activate
 $ pip3 install twine
 $ cp -R path/to/ssh-audit .
-$ cd ssh-audit/packages
+$ cd ssh-audit
 $ make -f Makefile.pypi
 $ make -f Makefile.pypi uploadtest
 
@@ -22,7 +22,7 @@ $ pip3 install --index-url https://test.pypi.org/simple ssh-audit
 To upload to production server:
 
 $ cd /tmp/pypi_upload; source bin/activate
-$ cd ssh-audit/pypi
+$ cd ssh-audit
 $ make -f Makefile.pypi uploadprod
 
 

pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
+requires = [
+    "setuptools>=40.8.0",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,44 @@
+[metadata]
+name = ssh-audit
+version = attr: ssh_audit.ssh_audit.VERSION
+author = Joe Testa
+author_email = jtesta@positronsecurity.com
+description = An SSH server & client configuration security auditing tool
+long_description = file: README.md
+long_description_content_type = text/markdown
+license_file = LICENSE
+url = https://github.com/jtesta/ssh-audit
+project_urls =
+    Source Code = https://github.com/jtesta/ssh-audit
+    Bug Tracker = https://github.com/jtesta/ssh-audit/issues
+classifiers =
+    Development Status :: 5 - Production/Stable
+    Intended Audience :: Information Technology
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.5
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: Implementation :: CPython
+    Programming Language :: Python :: Implementation :: PyPy
+    Topic :: Security
+    Topic :: Security :: Cryptography
+
+[options]
+packages = find:
+package_dir =
+     = src
+python_requires = >=3.5,<4
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+ssh_audit = policies/*
+
+[options.entry_points]
+console_scripts =
+    ssh-audit = ssh_audit.ssh_audit:main

setup.py

@@ -0,0 +1,23 @@
+import re
+import sys
+from setuptools import setup
+
+print_warning = False
+m = re.search(r'^VERSION\s*=\s*\'v(\d\.\d\.\d)\'', open('src/ssh_audit/ssh_audit.py').read(), re.M)
+if m is None:
+    # If we failed to parse the stable version, see if this is the development version.
+    m = re.search(r'^VERSION\s*=\s*\'v(\d\.\d\.\d-dev)\'', open('src/ssh_audit/ssh_audit.py').read(), re.M)
+    if m is None:
+        print("Error: could not parse VERSION variable from ssh_audit.py.")
+        sys.exit(1)
+    else:  # Continue with the development version, but print a warning later.
+        print_warning = True
+
+version = m.group(1)
+print("\n\nPackaging ssh-audit v%s...\n\n" % version)
+
+# see setup.cfg
+setup()
+
+if print_warning:
+    print("\n\n    !!! WARNING: development version detected (%s).  Are you sure you want to package this version?  Probably not...\n" % version)

src/ssh_audit/__main__.py

@@ -0,0 +1,2 @@
+from ssh_audit.ssh_audit import main
+main()