chg: dev: rename module, refactor package metadata, move to src layout

sarnold · sarnold · commit 2aef7726a880 · 2024-04-05T17:30:10.000-07:00
Signed-off-by: Steve Arnold &lt;sarnold@vctlabs.com&gt;
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,35 +5,98 @@ requires = [
 ]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "bmaptool"
+description = "BMAP tools"
+dynamic = ["version"]
+dependencies = [
+    "defusedxml",
+    "gpg >= 1.10.0",
+    'importlib-metadata>=4.6; python_version < "3.10"',
+]
+requires-python = ">=3.8"
+authors = [
+    {name = "Joshua Watt", email = "JPEWhacker@gmail.com"},
+    {name = "Trevor Woerner", email = "twoerner@gmail.com"},
+    {name = "Tim Orling", email = "ticotimo@gmail.com"},
+
+]
+readme = "README.md"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Embedded Systems",
+    "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
+    "Programming Language :: Python :: 3",
+    "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",
+]
+
+[project.optional-dependencies]
+dev = [
+    "black >= 22.3.0",
+    "six >= 1.16.0",
+]
+cov = [
+    "coverage",
+    "coverage_python_version",
+]
+doc = [
+    "sphinx",
+    "sphinx_git",
+    "recommonmark",
+    "sphinx_rtd_theme",
+    "sphinxcontrib-apidoc",
+]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+
+[project.urls]
+Homepage = "https://github.com/yoctoproject/bmaptool"
+Repository = "https://github.com/yoctoproject/bmaptool.git"
+Issues = "https://github.com/yoctoproject/bmaptool/issues"
+Changelog = "https://github.com/yoctoproject/bmaptool/blob/master/CHANGELOG.md"
+
+[project.scripts]
+bmaptool = "bmaptool.CLI:main"
+
 [tool.setuptools_scm]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-testpaths = ["tests",]
-log_cli =  true
+testpaths = ["tests", "src/bmaptool",]
+log_cli =  false
 doctest_optionflags = ["ELLIPSIS", "NORMALIZE_WHITESPACE",]
-addopts = "--strict-markers"
+addopts = "-ra -q -p no:warnings"
 markers = "subscript"
 
 [tool.coverage.run]
 branch = true
-include = ["bmaptools/"]
-source = [
-    "bmaptools",
-    ".tox/py*/lib/python*/site-packages/",
-]
-omit = [
-    "docs",
-    "tests",
-    ".tox",
-]
+source = ["src/bmaptool"]
+plugins = ["coverage_python_version"]
 
 [tool.coverage.paths]
-source = ["bmaptools"]
+source = [
+    "src/",
+    "*/site-packages"
+]
 
 [tool.coverage.report]
 fail_under = 40
 show_missing = true
+exclude_lines = [
+    "pragma: no cover",
+    "raise NotImplementedError",
+    "raise AssertionError",
+    "if typing.TYPE_CHECKING:",
+    "if TYPE_CHECKING:",
+]
 
 [tool.black]
 line-length = 90
diff --git a/requirements.txt b/requirements.txt
@@ -1,7 +1,7 @@
 defusedxml
-six
 gpg
 # dev tasks
+six
 pytest
 pytest-cov
 pylint
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/src/bmaptool/BmapCopy.py b/src/bmaptool/BmapCopy.py
diff --git a/src/bmaptool/BmapCreate.py b/src/bmaptool/BmapCreate.py
@@ -48,8 +48,8 @@
 # pylint: disable=R0902,R0903
 
 import hashlib
-from bmaptools.BmapHelpers import human_size
-from bmaptools import Filemap
+from bmaptool.BmapHelpers import human_size
+from bmaptool import Filemap
 
 # The bmap format version we generate.
 #
diff --git a/src/bmaptool/BmapHelpers.py b/src/bmaptool/BmapHelpers.py
diff --git a/src/bmaptool/CLI.py b/src/bmaptool/CLI.py
@@ -48,7 +48,7 @@
 else:
     from importlib.metadata import version
 
-VERSION = version('bmaptools')
+VERSION = version('bmaptool')
 
 log = logging.getLogger()  # pylint: disable=C0103
 
diff --git a/src/bmaptool/Filemap.py b/src/bmaptool/Filemap.py
@@ -34,7 +34,7 @@
 import fcntl
 import tempfile
 import logging
-from bmaptools import BmapHelpers
+from bmaptool import BmapHelpers
 
 _log = logging.getLogger(__name__)  # pylint: disable=C0103
 
diff --git a/src/bmaptool/TransRead.py b/src/bmaptool/TransRead.py
@@ -34,7 +34,7 @@
 import subprocess
 import netrc
 from six.moves.urllib import parse as urlparse
-from bmaptools import BmapHelpers
+from bmaptool import BmapHelpers
 
 _log = logging.getLogger(__name__)  # pylint: disable=C0103
 
diff --git a/src/bmaptool/__init__.py b/src/bmaptool/__init__.py
diff --git a/tests/helpers.py b/tests/helpers.py
@@ -30,7 +30,7 @@
 import struct
 import sys
 import os
-from bmaptools import BmapHelpers, BmapCopy, TransRead
+from bmaptool import BmapHelpers, BmapCopy, TransRead
 
 
 def _create_random_sparse_file(file_obj, size):
diff --git a/tests/oldcodebase/BmapCopy1_0.py b/tests/oldcodebase/BmapCopy1_0.py
@@ -48,7 +48,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # A list of supported image formats
 SUPPORTED_IMAGE_FORMATS = ("bz2", "gz", "tar.gz", "tgz", "tar.bz2")
diff --git a/tests/oldcodebase/BmapCopy2_0.py b/tests/oldcodebase/BmapCopy2_0.py
@@ -45,7 +45,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/oldcodebase/BmapCopy2_1.py b/tests/oldcodebase/BmapCopy2_1.py
@@ -45,7 +45,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/oldcodebase/BmapCopy2_2.py b/tests/oldcodebase/BmapCopy2_2.py
@@ -45,7 +45,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/oldcodebase/BmapCopy2_3.py b/tests/oldcodebase/BmapCopy2_3.py
@@ -45,7 +45,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/oldcodebase/BmapCopy2_4.py b/tests/oldcodebase/BmapCopy2_4.py
@@ -45,7 +45,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/oldcodebase/BmapCopy2_5.py b/tests/oldcodebase/BmapCopy2_5.py
@@ -59,7 +59,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/oldcodebase/BmapCopy2_6.py b/tests/oldcodebase/BmapCopy2_6.py
@@ -59,7 +59,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/oldcodebase/BmapCopy3_0.py b/tests/oldcodebase/BmapCopy3_0.py
@@ -59,7 +59,7 @@
 from six.moves import queue as Queue
 from six.moves import _thread as thread
 from xml.etree import ElementTree
-from bmaptools.BmapHelpers import human_size
+from bmaptool.BmapHelpers import human_size
 
 # The highest supported bmap format version
 SUPPORTED_BMAP_VERSION = "1.0"
diff --git a/tests/test_api_base.py b/tests/test_api_base.py
@@ -36,7 +36,7 @@
 import subprocess
 from six.moves import zip_longest
 from tests import helpers
-from bmaptools import BmapHelpers, BmapCreate, Filemap
+from bmaptool import BmapHelpers, BmapCreate, Filemap
 
 import pytest
 
diff --git a/tests/test_bmap_helpers.py b/tests/test_bmap_helpers.py
@@ -27,7 +27,7 @@
 
 import pytest
 
-from bmaptools import BmapHelpers
+from bmaptool import BmapHelpers
 
 # This is a work-around for Centos 6
 try:
diff --git a/tests/test_compat.py b/tests/test_compat.py
@@ -31,7 +31,7 @@
 import shutil
 import tempfile
 from tests import helpers
-from bmaptools import TransRead, BmapCopy
+from bmaptool import TransRead, BmapCopy
 
 # This is a work-around for Centos 6
 try:
diff --git a/tests/test_filemap.py b/tests/test_filemap.py
@@ -30,7 +30,7 @@
 import itertools
 import tests.helpers
 from six.moves import zip_longest
-from bmaptools import Filemap
+from bmaptool import Filemap
 
 import pytest
 
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@`
`48`	`48`	`# pylint: disable=R0902,R0903`
`49`	`49`
`50`	`50`	`import hashlib`
`51`		`-from bmaptools.BmapHelpers import human_size`
`52`		`-from bmaptools import Filemap`
	`51`	`+from bmaptool.BmapHelpers import human_size`
	`52`	`+from bmaptool import Filemap`
`53`	`53`
`54`	`54`	`# The bmap format version we generate.`
`55`	`55`	`#`