Improve scaffolding

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: pombredanne

Makefile

@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# ScanCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/python-inspector for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+# Python version can be specified with `$ PYTHON_EXE=python3.x make conf`
+VENV=venv
+ACTIVATE?=. ${VENV}/bin/activate;
+
+dev:
+	@echo "-> Configure the dev envt."
+	./configure --dev
+
+isort:
+	@echo "-> Apply isort changes to ensure proper imports ordering"
+	${VENV}/bin/isort --sl src tests
+
+black:
+	@echo "-> Apply black code formatter"
+	${VENV}/bin/black -l 100 src tests
+
+doc8:
+	@echo "-> Run doc8 validation"
+	@${ACTIVATE} doc8 --max-line-length 100 --ignore-path docs/_build/ --quiet docs/
+
+valid: isort black
+
+check:
+	@echo "-> Run pycodestyle (PEP8) validation"
+	@${ACTIVATE} pycodestyle --max-line-length=100 --exclude=venv,lib,thirdparty,docs,migrations,settings.py .
+	@echo "-> Run isort imports ordering validation"
+	@${ACTIVATE} isort --sl --check-only .
+	@echo "-> Run black validation"
+	@${ACTIVATE} black --check -l 100
+
+clean:
+	@echo "-> Clean the Python env"
+	./configure --clean
+
+test:
+	@echo "-> Run the test suite"
+	${VENV}/bin/pytest -vvs
+
+docs:
+	rm -rf docs/_build/
+	@${ACTIVATE} sphinx-build docs/ docs/_build/
+
+.PHONY:  conf dev check valid black isort clean test docs

setup.cfg

@@ -20,13 +20,27 @@ classifiers =
     Topic :: Utilities
 
 keywords =
-    utilities
+    open source
+    scan
+    package
+    dependency
+    pypi
+    python
+    SBOM
+    sca
+    dependencies
+    dependency resolution
+    resolver
+    resolvelib
+    pip
+    requirements
 
 license_files =
     apache-2.0.LICENSE
     NOTICE
     AUTHORS.rst
     CHANGELOG.rst
+    CODE_OF_CONDUCT.rst
 
 [options]
 package_dir =
@@ -40,27 +54,36 @@ setup_requires = setuptools_scm[toml] >= 4
 python_requires = >=3.6.*
 
 install_requires =
-    attr
-    commoncode
-    dparse2
+    attrs >= 18.1, !=20.1.0
+    click >= 6.7, !=7.0
+    colorama >= 0.3.9
+    commoncode >= 30.0.0
+    dparse2 >= 0.6.1
     importlib_metadata
-    packageurl_python
-    packaging
-    pip_requirements_parser
-    pkginfo2
-    requests
-    saneyaml
+    packageurl_python >= 0.9.0
+    pkginfo2 >= 30.0.0
+    pip-requirements-parser >= 31.2.0
+    requests >= 2.7.0
+    resolvelib
+    saneyaml >= 0.5.2
+    toml >= 0.10.0
 
 [options.packages.find]
 where = src
 
+[options.entry_points]
+console_scripts =
+    dad = python_inspector.resolve_cli:resolve_dependencies
 
 [options.extras_require]
 testing =
     pytest >= 6, != 7.0.0
     pytest-xdist >= 2
-    aboutcode-toolkit >= 6.0.0
+    aboutcode-toolkit >= 7.0.2
+    twine
     black
+    isort
+    pycodestyle
 
 docs =
     Sphinx >= 3.3.1

tests/README.rst

@@ -0,0 +1,30 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# ScanCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/skeleton for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+import subprocess
+import unittest
+
+
+class BaseTests(unittest.TestCase):
+    def test_codestyle(self):
+        """
+        This test shouldn't run in proliferated repositories.
+        """
+        args = "venv/bin/black --check -l 100 setup.py tests src"
+        try:
+            subprocess.check_output(args.split())
+        except subprocess.CalledProcessError as e:
+            print("===========================================================")
+            print(e.output)
+            print("===========================================================")
+            raise Exception(
+                "Black style check failed; please format the code using:\n"
+                "  python -m black -l 100 setup.py tests src",
+                e.output,
+            ) from e

tests/test_codestyle.py

@@ -7,9 +7,9 @@
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
+import configparser
 import subprocess
 import unittest
-import configparser
 
 
 class BaseTests(unittest.TestCase):