Merge pull request #44 from nipreps/doc/track-exit

DOC: Expose `track_exit()`, allow keyword arguments

README.md

@@ -68,6 +68,12 @@ If no end date is specified, the current datetime is used.
 
 </details>
 
+
+#### migas.track_exit()
+
+Register an exit function to send a final ping upon termination of the Python interpretter.
+The inputs are equivalent to `add_project()`.
+
 ## User Control
 
 `migas` can controlled by the following environmental variables:

migas/helpers.py

@@ -6,11 +6,17 @@
 from migas.operations import add_project
 
 
-def track_exit(project: str, version: str, error_funcs: dict | None = None) -> None:
-    atexit.register(_final_breadcrumb, project, version, error_funcs)
-
-def _final_breadcrumb(project: str, version: str, error_funcs: dict | None = None) -> dict:
-    kwargs = _inspect_error(error_funcs)
+def track_exit(project: str, version: str, error_funcs: dict | None = None, **kwargs) -> None:
+    atexit.register(_final_breadcrumb, project, version, error_funcs, **kwargs)
+
+def _final_breadcrumb(
+    project: str,
+    version: str,
+    error_funcs: dict | None = None,
+    **ping_kwargs,
+) -> dict:
+    status = _inspect_error(error_funcs)
+    kwargs = {**ping_kwargs, **status}
     return add_project(project, version, **kwargs)