Avoid hardcoding essential columns for --help

liskin · Nov 2, 2023 · 31079a3 · 31079a3
1 parent 3bbc929
commit 31079a3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -280,8 +280,8 @@ For a real life example, take a look at [my own rules.yaml](https://github.com/l
     Options:
       --rules FILENAME                Rules configuration (bikes, components, ...)  [default:
                                       /home/user/.config/strava_gear/rules.yaml]
-      --csv FILENAME                  Load activities from CSV instead of the strava-offline database (columns: name,
-                                      gear_id, start_date, moving_time, distance, total_elevation_gain)
+      --csv FILENAME                  Load activities from CSV instead of the strava-offline database (columns: distance,
+                                      gear_id, moving_time, name, start_date, total_elevation_gain)
       --strava-database PATH          Location of the strava-offline database  [default:
                                       /home/user/.local/share/strava_offline/strava.sqlite]
       -o, --output FILENAME           Output file  [default: -]

diff --git a/src/strava_gear/cli.py b/src/strava_gear/cli.py
@@ -7,6 +7,7 @@
 
 from .core import apply_rules
 from .core import warn_unknown_bikes
+from .input.activities import essential_columns
 from .input.activities import read_input_csv
 from .input.activities import read_strava_offline
 from .input.rules import read_rules
@@ -21,9 +22,9 @@
     help="Rules configuration (bikes, components, ...)")
 @click.option(
     '--csv', type=click.File('r'),
-    help="""
+    help=f"""
     Load activities from CSV instead of the strava-offline database
-    (columns: name, gear_id, start_date, moving_time, distance, total_elevation_gain)
+    (columns: {", ".join(sorted(essential_columns))})
     """)
 @click.option(
     '--strava-database', type=click.Path(path_type=Path),  # type: ignore [type-var] # debian typeshed compat

diff --git a/tests/readme/cmdline.md b/tests/readme/cmdline.md
@@ -8,8 +8,8 @@
     Options:
       --rules FILENAME                Rules configuration (bikes, components, ...)  [default:
                                       /home/user/.config/strava_gear/rules.yaml]
-      --csv FILENAME                  Load activities from CSV instead of the strava-offline database (columns: name,
-                                      gear_id, start_date, moving_time, distance, total_elevation_gain)
+      --csv FILENAME                  Load activities from CSV instead of the strava-offline database (columns: distance,
+                                      gear_id, moving_time, name, start_date, total_elevation_gain)
       --strava-database PATH          Location of the strava-offline database  [default:
                                       /home/user/.local/share/strava_offline/strava.sqlite]
       -o, --output FILENAME           Output file  [default: -]