chg: cleanup docstrings and desktop file, update pkg metadata and readme

Signed-off-by: Stephen Arnold <[email protected]>

README.rst

@@ -133,36 +133,42 @@ generated python byte-code. In the latter case, the list of installed
 files can be obtained with the following command::
 
   $ python -m pip show -f timew-addons
-    Name: timew-addons
-    Version: 0.1.2.dev3+gda11428.d20240825
-    Summary: A collection of timewarrior extensions and experiments
-    Home-page: https://github.com/sarnold/timew-addons
-    Author: Stephen L Arnold
-    Author-email:
-    License:
-    Location: /home/user/src/timew-addons/.tox/check/lib/python3.11/site-packages
-    Requires: munch, pycairo, PyGObject, timew-report
-    Required-by:
-    Files:
-      ../../../bin/timew-status-indicator
-      ../../../share/applications/timew-status-indicator.desktop
-      ../../../share/icons/hicolor/48x48/apps/timew.png
-      ../../../share/icons/hicolor/scalable/apps/timew.svg
-      ../../../share/icons/hicolor/scalable/status/timew_error.svg
-      ../../../share/icons/hicolor/scalable/status/timew_inactive.svg
-      ../../../share/icons/hicolor/scalable/status/timew_info.svg
-      ../../../share/icons/hicolor/scalable/status/timew_warning.svg
-      ../../../share/timew-addons/extensions/csv_rpt.py
-      ../../../share/timew-addons/extensions/onelineday.py
-      ../../../share/timew-addons/extensions/totals.py
-      timew_addons-0.1.2.dev3+gda11428.d20240825.dist-info/INSTALLER
-      timew_addons-0.1.2.dev3+gda11428.d20240825.dist-info/METADATA
-      timew_addons-0.1.2.dev3+gda11428.d20240825.dist-info/RECORD
-      timew_addons-0.1.2.dev3+gda11428.d20240825.dist-info/REQUESTED
-      timew_addons-0.1.2.dev3+gda11428.d20240825.dist-info/WHEEL
-      timew_addons-0.1.2.dev3+gda11428.d20240825.dist-info/top_level.txt
-      timew_status/__init__.py
-      timew_status/utils.py
+  Name: timew-addons
+  Version: 0.2.2.dev0+g4659e21.d20240901
+  Summary: A collection of timewarrior extensions and experiments
+  Home-page: https://github.com/sarnold/timew-addons
+  Author: Stephen L Arnold
+  Author-email: [email protected]
+  License: GPLv3+
+  Location: /home/nerdboy/src/timew-addons/.tox/py/lib/python3.11/site-packages
+  Requires: munch, pycairo, PyGObject, timew-report
+  Required-by:
+  Files:
+    ../../../bin/timew-status-indicator
+    ../../../share/applications/timew-status-indicator.desktop
+    ../../../share/icons/hicolor/48x48/apps/timew.png
+    ../../../share/icons/hicolor/scalable/apps/timew.svg
+    ../../../share/icons/hicolor/scalable/status/timew_error.svg
+    ../../../share/icons/hicolor/scalable/status/timew_inactive.svg
+    ../../../share/icons/hicolor/scalable/status/timew_info.svg
+    ../../../share/icons/hicolor/scalable/status/timew_warning.svg
+    ../../../share/timew-addons/extensions/__pycache__/csv_rpt.cpython-311.pyc
+    ../../../share/timew-addons/extensions/__pycache__/onelineday.cpython-311.pyc
+    ../../../share/timew-addons/extensions/__pycache__/totals.cpython-311.pyc
+    ../../../share/timew-addons/extensions/csv_rpt.py
+    ../../../share/timew-addons/extensions/onelineday.py
+    ../../../share/timew-addons/extensions/totals.py
+    timew_addons-0.2.2.dev0+g4659e21.d20240901.dist-info/INSTALLER
+    timew_addons-0.2.2.dev0+g4659e21.d20240901.dist-info/METADATA
+    timew_addons-0.2.2.dev0+g4659e21.d20240901.dist-info/RECORD
+    timew_addons-0.2.2.dev0+g4659e21.d20240901.dist-info/REQUESTED
+    timew_addons-0.2.2.dev0+g4659e21.d20240901.dist-info/WHEEL
+    timew_addons-0.2.2.dev0+g4659e21.d20240901.dist-info/direct_url.json
+    timew_addons-0.2.2.dev0+g4659e21.d20240901.dist-info/top_level.txt
+    timew_status/__init__.py
+    timew_status/__pycache__/__init__.cpython-311.pyc
+    timew_status/__pycache__/utils.cpython-311.pyc
+    timew_status/utils.py
 
 Generated files
 ---------------

data/timew-status-indicator.desktop

@@ -1,5 +1,5 @@
 [Desktop Entry]
-Name=Timew Status Tool
+Name=Timew Status Indicator
 Comment=Control and status tool for timew
 Exec=timew-status-indicator
 Icon=timew

setup.cfg

@@ -4,9 +4,10 @@ version = attr: setuptools_scm.get_version
 description = A collection of timewarrior extensions and experiments
 url = https://github.com/sarnold/timew-addons
 author = Stephen L Arnold
-email = [email protected]
+author_email = [email protected]
 long_description = file: README.rst
 long_description_content_type = text/rst; charset=UTF-8
+license = GPLv3+
 license_expression = GPL-3.0-or-later
 license_files = ["LICEN[CS]E*",]
 classifiers =
@@ -24,6 +25,9 @@ classifiers =
 
 keywords =
     appindicator
+    extensions
+    timewarrior
+    timew-report
     timew
 
 [options]

src/timew_status/utils.py

@@ -32,10 +32,12 @@
 
 def do_install(cfg):
     """
-    Install report extensions to timew extensions directory. The default
+    Install report extensions to timew extensions directory. The default src
     paths are preconfigured and should probably not be changed unless you
     know what you are doing, since *they are created during install or setup*.
-    Return a destination path string for each installed extension script.
+    You should, however, adjust the destination path in ``extensions_dir`` if
+    needed for your platform. Returns the destination path string for each
+    installed extension script.
 
     :param cfg: runtime CFG dict
     :return files: list of strings