Merge pull request #181 from OZI-Project/metadata-2.3

feat: deprecate ``home-page`` and ``download-url`` keys

Author: rjdbcm

doc/pyproject.md

@@ -75,6 +75,7 @@ of your package to show on PyPI. This should be written in reStructuredText
 
 ### `home-page`
 
+:::{deprecated} 1.12.0:::
 A string containing the URL for the package's home page.
 
 Example:
@@ -83,6 +84,7 @@ Example:
 
 ### `download-url`
 
+:::{deprecated} 1.12.0:::
 A string containing the URL for the package's source, will replace '{version}' with the current version.
 
 ### `dynamic`

ozi_build/metadata.py

@@ -148,7 +148,7 @@ def get_optional_dependencies(config):
     return res
 
 
-def get_simple_headers(config):
+def get_simple_headers(config):  # noqa: C901
     res = ''
     for key in [
         'summary',
@@ -160,6 +160,10 @@ def get_simple_headers(config):
         'license',
     ]:
         if key in config:
+            if key == 'home-page':
+                log.warning(
+                    'pyproject.toml:tools.ozi-build.metadata.home-page is deprecated since OZI.build 1.12, removal recommended.'
+                )
             res += '{}: {}\n'.format(key.capitalize(), config[key])
     for key, mdata_key in [
         ('provides', 'Provides-Dist'),
@@ -197,12 +201,12 @@ def get_license_headers(config):
 def get_download_url_headers(config):
     res = ''
     if 'download-url' in config:
+        log.warning(
+            'pyproject.toml:tools.ozi-build.metadata.download-url is deprecated since OZI.build 1.12, removal recommended.'
+        )
         if '{version}' in config['download-url']:
             res += f'Download-URL: {config["download-url"].replace("{version}", config["version"])}\n'
         else:
-            log.warning(
-                'pyproject.toml:tools.ozi-build.metadata.download-url missing {version} replace pattern'
-            )
             res += f'Download-URL: {config["download-url"]}\n'
     return res
 

ozi_build/schema.py

@@ -24,14 +24,16 @@
   (`.rst`, `.md` or `.txt`)."""
     },
     "home-page": {
-        "description": """A string containing the URL for the package's home page.
+        "description": """:::{deprecated} 1.12.0:::
+A string containing the URL for the package's home page.
 
 Example:
 
 `http://www.example.com/~cschultz/bvote/`"""
     },
     "download-url": {
-        "description": """A string containing the URL for the package's source, will replace '{version}' with the current version."""
+        "description": """:::{deprecated} 1.12.0:::
+A string containing the URL for the package's source, will replace '{version}' with the current version."""
     },
     "dynamic": {
         "description": """A list of other headers to be treated as dynamic fields."""

pyproject.toml

@@ -24,7 +24,6 @@ build-backend = "ozi_build.buildapi"
 
 [tool.ozi-build.metadata]
 summary = "Create pep517 compliant packages from the meson build system, OZI-maintained fork."
-home-page = "https://oziproject.dev"
 author = "Thibault Saunier"
 author-email = "tsaunier@gnome.org"
 description-file = "README.rst"
@@ -44,6 +43,7 @@ classifiers = [
 project-urls=[
     'Bug Tracker, https://github.com/OZI-Project/OZI.build/issues',
     'Documentation, https://build.oziproject.dev/',
+    'Homepage, https://oziproject.dev/',
 ]
 pure-python-abi="py3-none"