Add configuration for creating .desktop files in distributions.

Author: domdfcoding

repo_helper/configuration/__init__.py

@@ -76,6 +76,7 @@
 		)
 from repo_helper.configuration.other import (
 		additional_ignore,
+		desktopfile,
 		exclude_files,
 		imgbot_ignore,
 		pkginfo_extra,
@@ -205,6 +206,7 @@
 		"enable_devmode",
 		"pre_commit_exclude",
 		"dump_schema",
+		"desktopfile",
 		]
 
 
@@ -304,6 +306,7 @@ def parse_yaml(repo_path: PathLike) -> Dict:
 		use_experimental_backend,
 		pre_commit_exclude,
 		entry_points,
+		desktopfile,
 		]
 
 

repo_helper/configuration/other.py

@@ -36,7 +36,8 @@
 		"imgbot_ignore",
 		"pkginfo_extra",
 		"exclude_files",
-		"pre_commit_exclude"
+		"pre_commit_exclude",
+		"desktopfile",
 		]
 
 
@@ -163,3 +164,20 @@ class pre_commit_exclude(ConfigVar):  # noqa
 	@classmethod
 	def validate(cls, raw_config_vars: Optional[Dict[str, Any]] = None) -> Any:
 		return re.compile(super().validate(raw_config_vars)).pattern
+
+
+class desktopfile(ConfigVar):  # noqa
+	"""
+	A key value mapping of entries for a Linux ``.desktop`` file.
+
+	.. code-block:: yaml
+
+		desktopfile:
+		  Exec: wxIconSaver
+		  Icon: document-save
+
+	``Version``, ``Name`` and ``Comment`` are pre-populated from :conf:`version`, :conf:`modname` and :conf:`short_desc`.
+	"""
+
+	dtype = Dict[str, str]
+	default: Dict[str, str] = {}

repo_helper/configuration/packaging.py

@@ -266,6 +266,7 @@ class use_experimental_backend(ConfigVar):  # noqa
 	def validate(cls, raw_config_vars: Optional[Dict[str, Any]] = None) -> Any:  # noqa: D102
 
 		# this package
+		from repo_helper.configuration import desktopfile
 		from repo_helper.configuration.metadata import pure_python
 		from repo_helper.configuration.other import exclude_files
 
@@ -279,6 +280,7 @@ def validate(cls, raw_config_vars: Optional[Dict[str, Any]] = None) -> Any:  # n
 				additional_setup_args,
 				setup_pre,
 				py_modules,
+				desktopfile,
 				)
 
 		for key in disallowed_keys:

repo_helper/files/packaging.py

@@ -167,6 +167,9 @@ def make_setup(repo_path: pathlib.Path, templates: jinja2.Environment) -> List[s
 	data["description"] = repr(templates.globals["short_desc"])
 	data["py_modules"] = templates.globals["py_modules"]
 
+	if templates.globals["desktopfile"]:
+		data["data_files"] = "[('share/applications', ['{modname}.desktop'])]".format_map(templates.globals)
+
 	setup_args = sorted({**data, **templates.globals["additional_setup_args"]}.items())
 
 	setup_file.write_clean(setup.render(additional_setup_args="\n".join(f"\t\t{k}={v}," for k, v in setup_args)))

repo_helper/repo_helper_schema.json

@@ -427,6 +427,10 @@
     "entry_points": {
       "type": "object",
       "description": "A mapping of entry point categories to a list of entries for each category."
+    },
+    "desktopfile": {
+      "type": "object",
+      "description": "A key value mapping of entries for a Linux ``.desktop`` file."
     }
   },
   "required": [

repo_helper/templates/setup._py

@@ -12,6 +12,19 @@ sys.path.append('.')
 # this package
 from __pkginfo__ import *  # pylint: disable=wildcard-import
 
+{% if desktopfile %}
+from textwrap import dedent
+with open('{{ modname }}.desktop', 'w') as desktop:
+	desktop.write(dedent(f"""\
+[Desktop Entry]
+Version={__version__}
+Name={{ modname }}
+Comment={{ short_desc }}
+{% for k, v in desktopfile.items() %}{{ k }}={{ v }}
+{% endfor %}"""
+		))
+{% endif %}
+
 {{ "\n".join(setup_pre) }}
 
 setup(

tests/test_configuration_/test_parse_yaml.yml

@@ -27,6 +27,7 @@ console_scripts:
 - repo_helper = repo_helper.__main__:main
 - repo-helper = repo_helper.__main__:main
 copyright_years: '2020'
+desktopfile: {}
 docker_name: ''
 docker_shields: false
 docs_dir: doc-source

tests/test_files/test_packaging.py

@@ -56,6 +56,7 @@ def test_make_manifest_case_2(tmp_pathplus, demo_environment, file_regression: F
 
 def test_make_setup_case_1(tmp_pathplus, demo_environment, file_regression: FileRegressionFixture):
 	demo_environment.globals["use_experimental_backend"] = False
+	demo_environment.globals["desktopfile"] = {}
 
 	managed_files = make_setup(tmp_pathplus, demo_environment)
 	assert managed_files == ["setup.py"]
@@ -64,6 +65,7 @@ def test_make_setup_case_1(tmp_pathplus, demo_environment, file_regression: File
 
 def test_make_setup_case_2(tmp_pathplus, demo_environment, file_regression: FileRegressionFixture):
 	demo_environment.globals["use_experimental_backend"] = False
+	demo_environment.globals["desktopfile"] = {}
 
 	demo_environment.globals.update(
 			dict(