pkg-about 1.2.0__zip → 1.2.5__zip

{pkg_about-1.2.0 → pkg_about-1.2.5}/CHANGES.rst

@@ -1,6 +1,17 @@
 Changelog
 =========
 
+1.2.5 (2024-11-13)
+------------------
+- More unittests.
+- 100% code coverage.
+- Tox configuration is now in native (toml) format.
+- Setup (dependencies) update.
+
+1.2.2 (2024-10-30)
+------------------
+- Setup (dependencies) update.
+
 1.2.0 (2024-09-30)
 ------------------
 - Drop support for Python 3.8

{pkg_about-1.2.0 → pkg_about-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: pkg-about
-Version: 1.2.0
+Name: pkg_about
+Version: 1.2.5
 Summary: Shares Python package metadata at runtime.
 Author: Adam Karpierz
 Author-email: adam@karpierz.net
@@ -10,9 +10,9 @@ License: zlib/libpng License ; https://opensource.org/license/zlib
 Project-URL: Homepage, https://pypi.org/project/pkg-about/
 Project-URL: Documentation, https://pkg-about.readthedocs.io/
 Project-URL: Download, https://pypi.org/project/pkg-about/
-Project-URL: Source, https://github.com/karpierz/pkg-about
-Project-URL: Issues, https://github.com/karpierz/pkg-about/issues
-Keywords: pkg-about,pkg_about,__about__,packaging
+Project-URL: Source, https://github.com/karpierz/pkg_about
+Project-URL: Issues, https://github.com/karpierz/pkg_about/issues
+Keywords: pkg_about,__about__,packaging
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -33,14 +33,14 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: <4.0.0,>=3.9.0
 Description-Content-Type: text/x-rst; charset=UTF-8
 License-File: LICENSE
-Requires-Dist: setuptools>=75.1.0
-Requires-Dist: packaging>=24.1.0
+Requires-Dist: setuptools>=75.5.0
+Requires-Dist: packaging>=24.2.0
 Requires-Dist: importlib-metadata>=8.5.0
-Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Requires-Dist: tomli>=2.1.0; python_version < "3.11"
 Requires-Dist: docutils>=0.21.2
 Provides-Extra: doc
 Requires-Dist: Sphinx>=7.4.7; extra == "doc"
-Requires-Dist: sphinx-toolbox>=3.8.0; extra == "doc"
+Requires-Dist: sphinx-toolbox>=3.8.1; extra == "doc"
 Requires-Dist: sphinx-tabs>=3.4.5; extra == "doc"
 Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
 Requires-Dist: sphinxcontrib-spelling>=8.0.0; extra == "doc"
@@ -49,9 +49,9 @@ Requires-Dist: restructuredtext-lint>=1.4.0; extra == "doc"
 Requires-Dist: nbsphinx>=0.9.5; extra == "doc"
 Provides-Extra: test
 Requires-Dist: deepdiff>=8.0.1; extra == "test"
-Requires-Dist: rich>=13.8.1; extra == "test"
+Requires-Dist: rich>=13.9.4; extra == "test"
 
-pkg-about
+pkg_about
 =========
 
 Shares Python package metadata at runtime.
@@ -134,17 +134,28 @@ Authors
 
 * Adam Karpierz <adam@karpierz.net>
 
-.. |package| replace:: pkg-about
-.. |package_bold| replace:: **pkg-about**
+.. |package| replace:: pkg_about
+.. |package_bold| replace:: **pkg_about**
 .. |copyright| replace:: Copyright (c) 2020-2024 Adam Karpierz
-.. |respository| replace:: https://github.com/karpierz/pkg-about.git
-.. _Development page: https://github.com/karpierz/pkg-about
+.. |respository| replace:: https://github.com/karpierz/pkg_about.git
+.. _Development page: https://github.com/karpierz/pkg_about
 .. _PyPI record: https://pypi.org/project/pkg-about/
 .. _Documentation: https://pkg-about.readthedocs.io/
 
 Changelog
 =========
 
+1.2.5 (2024-11-13)
+------------------
+- More unittests.
+- 100% code coverage.
+- Tox configuration is now in native (toml) format.
+- Setup (dependencies) update.
+
+1.2.2 (2024-10-30)
+------------------
+- Setup (dependencies) update.
+
 1.2.0 (2024-09-30)
 ------------------
 - Drop support for Python 3.8

{pkg_about-1.2.0 → pkg_about-1.2.5}/README.rst

@@ -1,4 +1,4 @@
-pkg-about
+pkg_about
 =========
 
 Shares Python package metadata at runtime.
@@ -81,10 +81,10 @@ Authors
 
 * Adam Karpierz <adam@karpierz.net>
 
-.. |package| replace:: pkg-about
-.. |package_bold| replace:: **pkg-about**
+.. |package| replace:: pkg_about
+.. |package_bold| replace:: **pkg_about**
 .. |copyright| replace:: Copyright (c) 2020-2024 Adam Karpierz
-.. |respository| replace:: https://github.com/karpierz/pkg-about.git
-.. _Development page: https://github.com/karpierz/pkg-about
+.. |respository| replace:: https://github.com/karpierz/pkg_about.git
+.. _Development page: https://github.com/karpierz/pkg_about
 .. _PyPI record: https://pypi.org/project/pkg-about/
 .. _Documentation: https://pkg-about.readthedocs.io/

pkg_about-1.2.5/pyproject.toml

@@ -0,0 +1,279 @@
+# Copyright (c) 2020 Adam Karpierz
+# SPDX-License-Identifier: Zlib
+
+[build-system]
+build-backend = 'setuptools.build_meta'
+requires = ['setuptools>=75.5.0', 'packaging>=24.2.0', 'tox>=4.23.2']
+
+[project]
+name        = 'pkg_about'
+version     = '1.2.5'
+description = 'Shares Python package metadata at runtime.'
+urls.Homepage      = 'https://pypi.org/project/pkg-about/'
+urls.Documentation = 'https://pkg-about.readthedocs.io/'
+urls.Download      = 'https://pypi.org/project/pkg-about/'
+urls.Source        = 'https://github.com/karpierz/pkg_about'
+urls.Issues        = 'https://github.com/karpierz/pkg_about/issues'
+license = { text = 'zlib/libpng License ; https://opensource.org/license/zlib' }
+authors = [
+    { name  = 'Adam Karpierz' },
+    { email = 'adam@karpierz.net' },
+]
+maintainers = [
+    { name  = 'Adam Karpierz' },
+    { email = 'adam@karpierz.net' },
+]
+keywords = ['pkg_about', '__about__', 'packaging']
+classifiers = [
+    'Development Status :: 5 - Production/Stable',
+    'Intended Audience :: Developers',
+    'License :: OSI Approved :: zlib/libpng License',
+    'Operating System :: OS Independent',
+    'Natural Language :: Polish',
+    'Programming Language :: Python',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
+    'Programming Language :: Python :: 3 :: Only',
+    'Programming Language :: Python :: Implementation :: CPython',
+    'Programming Language :: Python :: Implementation :: PyPy',
+    'Topic :: Software Development :: Libraries :: Python Modules',
+]
+requires-python = '>=3.9.0,<4.0.0'
+dependencies = [
+    # mandatory
+    'setuptools>=75.5.0',
+    'packaging>=24.2.0',
+    'importlib-metadata>=8.5.0',
+    'tomli>=2.1.0 ; python_version < "3.11"',
+    'docutils>=0.21.2',
+    # others
+]
+dynamic = ['readme']
+optional-dependencies.'doc' = [
+    'Sphinx>=7.4.7',
+    'sphinx-toolbox>=3.8.1',
+    'sphinx-tabs>=3.4.5', # don't touch! sphinx-toolbox requires <3.4.7
+    'sphinx-copybutton>=0.5.2',
+    'sphinxcontrib-spelling>=8.0.0',
+    'sphinx-lint>=1.0.0',
+    'restructuredtext-lint>=1.4.0',
+    'nbsphinx>=0.9.5',
+]
+optional-dependencies.'test' = [
+    'deepdiff>=8.0.1',
+    'rich>=13.9.4',
+]
+
+[project.scripts]
+#'pkg_about' = 'pkg_about.__main__:main'
+
+[project.gui-scripts]
+#'pkg_about-gui' = 'pkg_about:main_gui'
+
+#[project.entry-points.'pkg_about.magical']
+#epoint = 'pkg_about:main_epoint'
+
+[tool.setuptools.dynamic]
+readme = { file = ['README.rst', 'CHANGES.rst'], content-type = 'text/x-rst; charset=UTF-8' }
+
+[tool.setuptools]
+license-files = ['LICENSE']
+include-package-data = true
+platforms = ['any']
+zip-safe = true
+
+[tool.setuptools.packages.find]
+namespaces = false
+where = ['src']
+
+[tool.setuptools.package-dir]
+'' = 'src'
+#'pkg_about.tests' = 'tests'
+
+[tool.setuptools.package-data]
+pkg_about = [
+]
+
+[tool.setuptools.exclude-package-data]
+'*' = ['*.c','*.h','*.cpp','*.hpp','*.cxx','*.hxx','*.pyx','*.pxd']
+pkg_about = [
+]
+
+[tool.coverage]
+# run
+run.source = [
+    'pkg_about',
+    'tests',
+]
+run.omit = [
+]
+run.branch = true
+run.data_file = '.tox/coverage/.coverage'
+run.plugins = ['covdefaults']
+# report
+report.exclude_lines = [
+    # Regexes
+    # Have to re-enable the standard pragma
+    '^\s*if\s+self\.debug\s*:',
+    '^\s*if\s+__debug__\s*:',
+    '^\s*if\s+(0|False)\s*:',
+    '''if\s+__name__.*\s*==\s*['"]__main__['"]\s*:''',
+    '^\s*@unittest\.skip\(',
+    '^\s*@unittest\.skipIf\(sys\.platform\.startswith\("win"\)',
+]
+report.omit = [
+    'tests/run.py',
+]
+report.skip_covered = false
+# html report
+html.directory = '.tox/coverage/.coverage.html'
+
+[tool.flake8]
+filename = ['*.py','*.pyx']
+#include = ['tests']
+#exclude = ['.tox','*.egg','.git','__pycache__','build','_build','docs/_build','dist']
+max-line-length = 99
+ignore = ['E126','E203','E221','E251','E302','E701','E702','E731',
+          'E122','E127','E128','E222','E272','E241','E266','E226','E704',
+          'D100','D101','D102','D103','D104','D400','D401','D202',
+          'N806','N802','N803','N801',
+          'I100','W503']
+# (e.g. 'E4','W') default: 'E121','E123','126','226','E24','704'
+#select =
+#select = ['E','W','F','N','I']
+output-file = '.tox/lint/flake8out.txt'
+count = true
+#show-pep8,
+#show-source
+#verbose
+#quiet
+
+#
+# Configuration(s) for tox
+#
+
+[tool.tox]  # pkg_about
+env_list = [{replace='ref',of=['tool','tox','labels','py'],extend=true}, 'coverage', 'lint', 'docs']
+min_version = '4.23.2'
+skip_missing_interpreters = true
+requires = [
+    {replace='ref',of=['tool','tox','_','base','deps'],extend=true},
+    'virtualenv>=20.27.1',
+    'tox-tags>=0.2.0',
+]
+[tool.tox.labels]
+py = ['py39','py310','py311','py312','py313', 'pypy39','pypy310']
+prepare  = ['prepare']
+coverage = ['coverage']
+lint = ['lint']
+docs = ['docs']
+build  = [{replace='ref',of=['tool','tox','labels','py'],extend=true}, 'docs', 'build']
+deploy = [{replace='ref',of=['tool','tox','labels','build'],extend=true}, 'publish']
+
+[tool.tox._.base]
+base_python = ['python3.12']
+deps = [
+    'pip>=24.3.1',
+    'setuptools>=75.5.0',
+]
+package_subdir = 'pkg_about'
+
+[tool.tox.env_run_base]
+set_env.PYTHONDONTWRITEBYTECODE = '1'
+commands = [
+    ['{env_python}','--version'],
+    ['{env_python}','-m','tests',{replace='posargs',extend=true}],
+]
+extras = ['test']
+deps = [
+    {replace='ref',of=['tool','tox','_','base','deps'],extend=true},
+]
+
+[tool.tox.env.'prepare']
+base_python = {replace='ref',of=['tool','tox','_','base','base_python']}
+skip_install = true
+allowlist_externals = [
+    'cmd',
+    '.build',
+]
+commands = [
+    ['cmd','/C','if','exist','.build.cmd','.build.cmd'],
+]
+extras = []
+deps = []
+
+[tool.tox.env.'coverage']
+base_python = {replace='ref',of=['tool','tox','_','base','base_python']}
+commands = [
+    ['{env_python}','-m','coverage','erase'],
+    ['-','{env_python}','-m','coverage','run','-m','tests',{replace="posargs",extend=true}],
+    ['-','{env_python}','-m','coverage','html'],
+    ['{env_python}','-m','coverage','report'],
+]
+deps = [
+    {replace='ref',of=['tool','tox','env_run_base','deps'],extend=true},
+    'coverage>=7.6.4',
+    'covdefaults>=2.3.0',
+    'diff-cover>=9.2.0',
+]
+
+[tool.tox.env.'docs']
+base_python = {replace='ref',of=['tool','tox','_','base','base_python']}
+commands = [
+    ['{env_python}','-m','sphinxlint','--ignore','.tox','--ignore','build','--ignore','dist'],
+   #['{env_python}','-m','sphinx.apidoc','-f','{envsitepackagesdir}/{[tool.tox._.base]package_subdir}'],
+    ['{env_python}','-m','sphinx.cmd.build','-W','-a','-b','html','-E','./docs','./build/docs/html'],
+    ['{env_python}','-m','sphinx.cmd.build','-W','-a','-b','linkcheck','./docs','./build/docs/html'],
+    ['{env_python}','-m','sphinx.cmd.build','-W','-a','-b','doctest',  './docs','./build/docs/html'],
+]
+extras = ['doc']
+deps = [
+    {replace='ref',of=['tool','tox','_','base','deps'],extend=true},
+]
+
+[tool.tox.env.'build']
+depends = [{replace='ref',of=['tool','tox','labels','py'],extend=true}, 'docs']
+base_python = {replace='ref',of=['tool','tox','_','base','base_python']}
+commands = [
+    ['{env_python}','-W','ignore','-c','from setuptools import setup ; setup()','--quiet','sdist','--formats=zip'],
+    ['{env_python}','-W','ignore','-c','from setuptools import setup ; setup()','--quiet','bdist_wheel'],
+    # check out for PyPi
+    ['{env_python}','-m','twine','check','dist/*'],
+]
+deps = [
+    {replace='ref',of=['tool','tox','env_run_base','deps'],extend=true},
+    'twine>=5.1.1',
+]
+
+[tool.tox.env.'publish']
+depends = ['build']
+base_python = {replace='ref',of=['tool','tox','_','base','base_python']}
+skip_install = true
+commands = [
+    # publish on PyPi
+    ['{env_python}','-m','twine','upload','dist/*'],
+]
+extras = []
+deps = [
+    'twine>=5.1.1',
+]
+
+[tool.tox.env.'lint']
+base_python = {replace='ref',of=['tool','tox','_','base','base_python']}
+commands = [
+    ['{env_python}','-m','flake8','{envsitepackagesdir}/{[tool.tox._.base]package_subdir}/'],
+]
+extras = []
+deps = [
+    {replace='ref',of=['tool','tox','env_run_base','deps'],extend=true},
+    'flake8>=7.1.1',
+    'flake8-pyproject>=1.2.3',
+    'flake8-docstrings>=1.7.0',
+    'pep8-naming>=0.14.1',
+    'flake8-builtins>=2.5.0',
+    'flake8-deprecated>=2.2.1',
+]

pkg_about-1.2.5/setup.cfg

@@ -0,0 +1,12 @@
+[metadata]
+name = pkg_about
+description = Intentionally temporary/random. Will/should be covered from pyproject.toml.
+author = John Smith
+author_email = smith@domain.invalid
+maintainer = John Smith
+maintainer_email = smith@domain.invalid
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

{pkg_about-1.2.0 → pkg_about-1.2.5}/src/pkg_about/_about.py

@@ -75,10 +75,10 @@ def about_from_setup(package_path=None):
     setup_cfg_path = package_path/"setup.cfg"
     readme_path    = package_path/"README.rst"
     metadata = {}
-    if setup_cfg_path.exists():
+    if setup_cfg_path.exists():  # pragma: no branch
         metadata.update(read_setupcfg(setup_cfg_path,
                         ignore_option_errors=True).get("metadata", {}))
-    if pyproject_path.exists():
+    if pyproject_path.exists():  # pragma: no branch
         if read_pyprojecttoml:
             metadata.update(read_pyprojecttoml(pyproject_path,
                             ignore_option_errors=True).get("project", {}))
@@ -134,7 +134,7 @@ def about_from_setup(package_path=None):
                                    (next(about_py).open("rt", encoding="utf-8")
                                     if about_py else ())
                                    if copyr_patt.split(line)[1:]), "None"))
-        if __copyright__ is None and readme_path.exists():
+        if __copyright__ is None and readme_path.exists():  # pragma: no branch
             __copyright__ = get_copyright(readme_path.read_text(encoding="utf-8"))
 
     pkg_globals["about"] = about
@@ -145,9 +145,11 @@ def about_from_setup(package_path=None):
 def __get(mdata, *keys):
     for key in keys:
         if isinstance(mdata, dict):
-            if key not in mdata: return None
+            if key not in mdata:
+                return None
         elif isinstance(mdata, (list, tuple)):
-            if key >= len(mdata): return None
+            if key >= len(mdata):  # pragma: no cover
+                return None
         else:  # pragma: no cover
             return None
         mdata = mdata[key]
@@ -158,7 +160,7 @@ def __get_copyright(description):
     from docutils.core import publish_doctree
     from docutils import nodes
     copyr = None
-    if description is not None:
+    if description is not None:  # pragma: no branch
         document = publish_doctree(description)
         subst_name = document.substitution_names.get("copyright")
         substitution = document.substitution_defs.get(subst_name)
@@ -167,16 +169,15 @@ def __get_copyright(description):
         else:
             # Try to get from 'License' section
             section = document.ids.get(document.nameids.get("license"))
-            if section is not None:
+            if section is not None:  # pragma: no branch
                 lblock = section.next_node(nodes.line_block)
-                if lblock is not None:
+                if lblock is not None:  # pragma: no branch
                     copyr = next((line for _ in lblock.findall(nodes.line)
                                   if ((line := _.astext().lstrip()).lower()
                                       .startswith("copyright"))), None)
     return copyr
 
 
-
 __release_levels = dict(
     a     = "alpha",
     b     = "beta",

{pkg_about-1.2.0 → pkg_about-1.2.5}/src/pkg_about.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: pkg-about
-Version: 1.2.0
+Name: pkg_about
+Version: 1.2.5
 Summary: Shares Python package metadata at runtime.
 Author: Adam Karpierz
 Author-email: adam@karpierz.net
@@ -10,9 +10,9 @@ License: zlib/libpng License ; https://opensource.org/license/zlib
 Project-URL: Homepage, https://pypi.org/project/pkg-about/
 Project-URL: Documentation, https://pkg-about.readthedocs.io/
 Project-URL: Download, https://pypi.org/project/pkg-about/
-Project-URL: Source, https://github.com/karpierz/pkg-about
-Project-URL: Issues, https://github.com/karpierz/pkg-about/issues
-Keywords: pkg-about,pkg_about,__about__,packaging
+Project-URL: Source, https://github.com/karpierz/pkg_about
+Project-URL: Issues, https://github.com/karpierz/pkg_about/issues
+Keywords: pkg_about,__about__,packaging
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -33,14 +33,14 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: <4.0.0,>=3.9.0
 Description-Content-Type: text/x-rst; charset=UTF-8
 License-File: LICENSE
-Requires-Dist: setuptools>=75.1.0
-Requires-Dist: packaging>=24.1.0
+Requires-Dist: setuptools>=75.5.0
+Requires-Dist: packaging>=24.2.0
 Requires-Dist: importlib-metadata>=8.5.0
-Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Requires-Dist: tomli>=2.1.0; python_version < "3.11"
 Requires-Dist: docutils>=0.21.2
 Provides-Extra: doc
 Requires-Dist: Sphinx>=7.4.7; extra == "doc"
-Requires-Dist: sphinx-toolbox>=3.8.0; extra == "doc"
+Requires-Dist: sphinx-toolbox>=3.8.1; extra == "doc"
 Requires-Dist: sphinx-tabs>=3.4.5; extra == "doc"
 Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
 Requires-Dist: sphinxcontrib-spelling>=8.0.0; extra == "doc"
@@ -49,9 +49,9 @@ Requires-Dist: restructuredtext-lint>=1.4.0; extra == "doc"
 Requires-Dist: nbsphinx>=0.9.5; extra == "doc"
 Provides-Extra: test
 Requires-Dist: deepdiff>=8.0.1; extra == "test"
-Requires-Dist: rich>=13.8.1; extra == "test"
+Requires-Dist: rich>=13.9.4; extra == "test"
 
-pkg-about
+pkg_about
 =========
 
 Shares Python package metadata at runtime.
@@ -134,17 +134,28 @@ Authors
 
 * Adam Karpierz <adam@karpierz.net>
 
-.. |package| replace:: pkg-about
-.. |package_bold| replace:: **pkg-about**
+.. |package| replace:: pkg_about
+.. |package_bold| replace:: **pkg_about**
 .. |copyright| replace:: Copyright (c) 2020-2024 Adam Karpierz
-.. |respository| replace:: https://github.com/karpierz/pkg-about.git
-.. _Development page: https://github.com/karpierz/pkg-about
+.. |respository| replace:: https://github.com/karpierz/pkg_about.git
+.. _Development page: https://github.com/karpierz/pkg_about
 .. _PyPI record: https://pypi.org/project/pkg-about/
 .. _Documentation: https://pkg-about.readthedocs.io/
 
 Changelog
 =========
 
+1.2.5 (2024-11-13)
+------------------
+- More unittests.
+- 100% code coverage.
+- Tox configuration is now in native (toml) format.
+- Setup (dependencies) update.
+
+1.2.2 (2024-10-30)
+------------------
+- Setup (dependencies) update.
+
 1.2.0 (2024-09-30)
 ------------------
 - Drop support for Python 3.8

{pkg_about-1.2.0 → pkg_about-1.2.5}/src/pkg_about.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ LICENSE
 MANIFEST.in
 README.rst
 pyproject.toml
+setup.cfg
 docs/CHANGES.rst
 docs/README.rst
 docs/conf.py

{pkg_about-1.2.0 → pkg_about-1.2.5}/src/pkg_about.egg-info/requires.txt

@@ -1,14 +1,14 @@
-setuptools>=75.1.0
-packaging>=24.1.0
+setuptools>=75.5.0
+packaging>=24.2.0
 importlib-metadata>=8.5.0
 docutils>=0.21.2
 
 [:python_version < "3.11"]
-tomli>=2.0.1
+tomli>=2.1.0
 
 [doc]
 Sphinx>=7.4.7
-sphinx-toolbox>=3.8.0
+sphinx-toolbox>=3.8.1
 sphinx-tabs>=3.4.5
 sphinx-copybutton>=0.5.2
 sphinxcontrib-spelling>=8.0.0
@@ -18,4 +18,4 @@ nbsphinx>=0.9.5
 
 [test]
 deepdiff>=8.0.1
-rich>=13.8.1
+rich>=13.9.4

{pkg_about-1.2.0 → pkg_about-1.2.5}/tests/test_main.py

@@ -2,16 +2,26 @@
 # SPDX-License-Identifier: Zlib
 
 import unittest
+import sys
 from pathlib import Path
+import textwrap
 
 import pkg_about
+from pkg_about._about import __get_copyright as get_copyright
 
 
 class MainTestCase(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        cls.version_expected = "1.2.0"
+        pyproject_path = Path(__file__).resolve().parent.parent/"pyproject.toml"
+        if sys.version_info >= (3, 11):
+            import tomllib
+        else:  # pragma: no cover
+            import tomli as tomllib
+        with pyproject_path.open("rb") as file:
+            metadata = tomllib.load(file).get("project", {})
+        cls.version_expected = metadata["version"]
         version_parts = cls.version_expected.split(".")
         cls.version_major_expected = int(version_parts[0])
         cls.version_minor_expected = int(version_parts[1])
@@ -19,7 +29,7 @@ class MainTestCase(unittest.TestCase):
 
     def test_about(self):
         pkg_about.about("pkg_about")
-        self.assertEqual(__title__, "pkg-about")
+        self.assertEqual(__title__, "pkg_about")
         self.assertEqual(__version__, self.version_expected)
         self.assertEqual(__version_info__.major, self.version_major_expected)
         self.assertEqual(__version_info__.minor, self.version_minor_expected)
@@ -39,7 +49,7 @@ class MainTestCase(unittest.TestCase):
 
     def test_about_from_setup(self):
         pkg_about.about_from_setup(Path(__file__).resolve().parent.parent)
-        self.assertEqual(about.__title__, "pkg-about")
+        self.assertEqual(about.__title__, "pkg_about")
         self.assertEqual(about.__version__, self.version_expected)
         self.assertEqual(about.__version_info__.major, self.version_major_expected)
         self.assertEqual(about.__version_info__.minor, self.version_minor_expected)
@@ -56,3 +66,27 @@ class MainTestCase(unittest.TestCase):
         self.assertEqual(about.__license__,
                          "zlib/libpng License ; https://opensource.org/license/zlib")
         self.assertEqual(about.__copyright__, "Copyright (c) 2020-2024 Adam Karpierz")
+
+    def test_get_copyright(self):
+        self.assertEqual(get_copyright(textwrap.dedent(
+            """
+            License
+            =======
+
+              | |copyright|
+              | Licensed under the zlib/libpng License
+              | https://opensource.org/license/zlib
+              | Please refer to the accompanying LICENSE file.
+
+            .. |copyright| replace:: Copyright (c) 2020-2024 Adam Karpierz
+            """)), "Copyright (c) 2020-2024 Adam Karpierz")
+        self.assertEqual(get_copyright(textwrap.dedent(
+            """
+            License
+            =======
+
+              | Copyright (c) 2020-2024 Adam Karpierz
+              | Licensed under the zlib/libpng License
+              | https://opensource.org/license/zlib
+              | Please refer to the accompanying LICENSE file.
+            """)), "Copyright (c) 2020-2024 Adam Karpierz")

pkg_about-1.2.0/pyproject.toml

@@ -1,267 +0,0 @@
-# Copyright (c) 2020 Adam Karpierz
-# SPDX-License-Identifier: Zlib
-
-[build-system]
-build-backend = 'setuptools.build_meta'
-requires = ['setuptools>=75.1.0', 'wheel>=0.44.0', 'packaging>=24.1.0', 'tox>=4.20.0']
-
-[project]
-name        = 'pkg-about'
-version     = '1.2.0'
-description = 'Shares Python package metadata at runtime.'
-urls.Homepage      = 'https://pypi.org/project/pkg-about/'
-urls.Documentation = 'https://pkg-about.readthedocs.io/'
-urls.Download      = 'https://pypi.org/project/pkg-about/'
-urls.Source        = 'https://github.com/karpierz/pkg-about'
-urls.Issues        = 'https://github.com/karpierz/pkg-about/issues'
-license = { text = 'zlib/libpng License ; https://opensource.org/license/zlib' }
-authors = [
-    { name  = 'Adam Karpierz' },
-    { email = 'adam@karpierz.net' },
-]
-maintainers = [
-    { name  = 'Adam Karpierz' },
-    { email = 'adam@karpierz.net' },
-]
-keywords = ['pkg-about', 'pkg_about', '__about__', 'packaging']
-classifiers = [
-    'Development Status :: 5 - Production/Stable',
-    'Intended Audience :: Developers',
-    'License :: OSI Approved :: zlib/libpng License',
-    'Operating System :: OS Independent',
-    'Natural Language :: Polish',
-    'Programming Language :: Python',
-    'Programming Language :: Python :: 3',
-    'Programming Language :: Python :: 3.9',
-    'Programming Language :: Python :: 3.10',
-    'Programming Language :: Python :: 3.11',
-    'Programming Language :: Python :: 3.12',
-    'Programming Language :: Python :: 3.13',
-    'Programming Language :: Python :: 3 :: Only',
-    'Programming Language :: Python :: Implementation :: CPython',
-    'Programming Language :: Python :: Implementation :: PyPy',
-    'Topic :: Software Development :: Libraries :: Python Modules',
-]
-requires-python = '>=3.9.0,<4.0.0'
-dependencies = [
-    # mandatory
-    'setuptools>=75.1.0',
-    'packaging>=24.1.0',
-    'importlib-metadata>=8.5.0',
-    'tomli>=2.0.1 ; python_version < "3.11"',
-    'docutils>=0.21.2',
-    # others
-]
-dynamic = ['readme']
-[project.optional-dependencies]
-doc = [
-    'Sphinx>=7.4.7',
-    'sphinx-toolbox>=3.8.0',
-    'sphinx-tabs>=3.4.5',
-    'sphinx-copybutton>=0.5.2',
-    'sphinxcontrib-spelling>=8.0.0',
-    'sphinx-lint>=1.0.0',
-    'restructuredtext-lint>=1.4.0',
-    'nbsphinx>=0.9.5',
-]
-test = [
-    'deepdiff>=8.0.1',
-    'rich>=13.8.1',
-]
-
-[project.scripts]
-#'pkg_about' = 'pkg_about.__main__:main'
-
-[project.gui-scripts]
-#'pkg_about-gui' = 'pkg_about:main_gui'
-
-#[project.entry-points.'pkg_about.magical']
-#epoint = 'pkg_about:main_epoint'
-
-[tool.setuptools.dynamic]
-readme = { file = ['README.rst', 'CHANGES.rst'], content-type = 'text/x-rst; charset=UTF-8' }
-
-[tool.setuptools]
-license-files = ['LICENSE']
-include-package-data = true
-platforms = ['any']
-zip-safe = true
-
-[tool.setuptools.packages.find]
-namespaces = false
-where = ['src']
-
-[tool.setuptools.package-dir]
-'' = 'src'
-#'pkg_about.tests' = 'tests'
-
-[tool.setuptools.package-data]
-pkg_about = [
-]
-
-[tool.setuptools.exclude-package-data]
-'*' = ['*.c','*.h','*.cpp','*.hpp','*.cxx','*.hxx','*.pyx','*.pxd']
-pkg_about = [
-]
-
-[tool.coverage.run]
-source = [
-    'pkg_about',
-    'tests',
-]
-omit = [
-]
-data_file = '.tox/coverage/.coverage'
-plugins = ['covdefaults']
-
-[tool.coverage.report]
-exclude_lines = [
-    # Regexes
-    # Have to re-enable the standard pragma
-    '^\s*if\s+self\.debug\s*:',
-    '^\s*if\s+__debug__\s*:',
-    '^\s*if\s+(0|False)\s*:',
-    '''if\s+__name__.*\s*==\s*['"]__main__['"]\s*:''',
-    '^\s*@unittest\.skip\(',
-    '^\s*@unittest\.skipIf\(sys\.platform\.startswith\("win"\)',
-]
-omit = [
-    'tests/run.py',
-]
-skip_covered = false
-
-[tool.coverage.html]
-directory = '.tox/coverage/.coverage.html'
-
-[tool.flake8]
-filename = ['*.py','*.pyx']
-#include = ['tests']
-#exclude = ['.tox','*.egg','.git','__pycache__','build','_build','docs/_build','dist']
-max-line-length = 99
-ignore = ['E126','E203','E221','E251','E302','E701','E702','E731',
-          'E122','E127','E128','E222','E272','E241','E266','E226','E704',
-          'D100','D101','D102','D103','D104','D400','D401','D202',
-          'N806','N802','N803','N801',
-          'I100','W503']
-# (e.g. 'E4','W') default: 'E121','E123','126','226','E24','704'
-#select =
-#select = ['E','W','F','N','I']
-output-file = '.tox/lint/flake8out.txt'
-count = true
-#show-pep8,
-#show-source
-#verbose
-#quiet
-
-#
-# Configuration(s) for tox
-#
-
-[tool.tox]
-legacy_tox_ini = """
-[tox]
-envlist = py{39,310,311,312,313}, pypy{39,310}, docs
-labels =
-    py = py{39,310,311,312,313}, pypy{39,310}
-    prepare = prepare
-    coverage = coverage
-    lint = lint
-    docs = docs
-    build  = py{39,310,311,312,313}, pypy{39,310}, docs, build
-    deploy = py{39,310,311,312,313}, pypy{39,310}, docs, build, publish
-minversion = 4.20.0
-skip_missing_interpreters = true
-requires =
-    {[base]deps}
-    virtualenv>=20.26.6
-    tox-tags>=0.2.0
-
-[base]
-basepython = python3.12
-deps =
-    pip>=24.2.0
-    setuptools>=75.1.0
-    wheel>=0.44.0
-packagesubdir = pkg_about
-
-[testenv]
-passenv = WINDIR
-setenv =
-    PYTHONDONTWRITEBYTECODE = 1
-commands =
-    {envpython} --version
-    {envpython} -m tests {posargs}
-extras = test
-deps =
-    {[base]deps}
-
-[testenv:prepare]
-basepython = {[base]basepython}
-skip_install = true
-allowlist_externals =
-    cmd
-    .build
-commands =
-    cmd /C if exist .build.cmd .build.cmd
-
-[testenv:coverage]
-basepython = {[base]basepython}
-commands =
-    {envpython} -m coverage erase
-    -{envpython} -m coverage run -m tests {posargs}
-    {envpython} -m coverage report
-    {envpython} -m coverage html
-deps =
-    {[testenv]deps}
-    coverage>=7.6.1
-    covdefaults>=2.3.0
-    diff-cover>=9.2.0
-
-[testenv:docs]
-basepython = {[base]basepython}
-commands =
-    {envpython} -m sphinxlint --ignore .tox --ignore build --ignore dist
-   #{envpython} -m sphinx.apidoc -f {envsitepackagesdir}/{[base]packagesubdir}
-    {envpython} -m sphinx.cmd.build -W -a -b html -E   ./docs ./build/docs/html
-    {envpython} -m sphinx.cmd.build -W -a -b linkcheck ./docs ./build/docs/html
-    {envpython} -m sphinx.cmd.build -W -a -b doctest   ./docs ./build/docs/html
-extras = doc
-deps =
-
-[testenv:build]
-depends = py{39,310,311,312,313}, pypy{39,310}, docs
-basepython = {[base]basepython}
-commands =
-    {envpython} -W ignore -c "from setuptools import setup ; setup()" --quiet sdist --formats=zip
-    {envpython} -W ignore -c "from setuptools import setup ; setup()" --quiet bdist_wheel
-    # check out for PyPi
-    {envpython} -m twine check dist/*
-deps =
-    {[testenv]deps}
-    twine>=5.1.1
-
-[testenv:publish]
-depends = build
-basepython = {[base]basepython}
-skip_install = true
-commands =
-    # publish on PyPi
-    {envpython} -m twine upload dist/*
-extras =
-deps =
-    twine>=5.1.1
-
-[testenv:lint]
-basepython = {[base]basepython}
-commands =
-    {envpython} -m flake8 {envsitepackagesdir}/{[base]packagesubdir}/
-extras =
-deps =
-    {[testenv]deps}
-    flake8>=7.1.1
-    flake8-pyproject>=1.2.3
-    flake8-docstrings>=1.7.0
-    pep8-naming>=0.14.1
-    flake8-builtins>=2.5.0
-    flake8-deprecated>=2.2.1
-"""

pkg_about-1.2.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-