Merge pull request #183 from alexis-m/fix-snakemd-version

Fix snakemd 2.x deprecations in Jupyter notebooks

.gitignore

@@ -101,4 +101,6 @@ GarminConnectConfig.json
 *.png
 test/test_files
 my-defines.mk
-test/*.txt
+test/*.txt
+
+Jupyter/.ipynb_checkpoints/

Jupyter/activities.ipynb

@@ -45,9 +45,9 @@
     "            average_distance = total_distance / records\n",
     "        return [sport_title, records, format_number(total_distance, 1), format_number(average_distance, 1)]\n",
     "\n",
-    "doc = snakemd.new_doc(\"activities\")\n",
+    "doc = snakemd.new_doc()\n",
     "\n",
-    "doc.add_header(\"Activities Report\")\n",
+    "doc.add_heading(\"Activities Report\")\n",
     "doc.add_paragraph(\"Analysis of all activities in the database.\")\n",
     "\n",
     "doc.add_table(\n",
@@ -73,7 +73,7 @@
     "    sport_stat = __report_sport(Activities.sport, sport_name)\n",
     "    if sport_stat:\n",
     "        sports_stats.append(sport_stat)\n",
-    "doc.add_header(\"Sport Type Statistics\", 3)\n",
+    "doc.add_heading(\"Sport Type Statistics\", 3)\n",
     "doc.add_table(['Sport', 'Total Activities', f'Total Distance ({distance_units})', f\"Average Distance ({distance_units})\"], sports_stats)\n",
     "\n",
     "def __format_activity(activity):\n",
@@ -86,7 +86,7 @@
     "\n",
     "activities = Activities.get_latest(garmin_act_db, 10)\n",
     "rows = [__format_activity(activity) for activity in activities]\n",
-    "doc.add_header(\"Last Ten Activities\", 3)\n",
+    "doc.add_heading(\"Last Ten Activities\", 3)\n",
     "doc.add_table(['Id', 'Name', 'Type', 'Sport', f'Distance ({distance_units})', 'Elapsed Time', f'Speed ({unit_strings[fitfile.units.UnitTypes.speed]})', f'Pace ({unit_strings[fitfile.units.UnitTypes.pace]})', 'Calories'], rows)\n",
     "\n",
     "rows = []\n",
@@ -97,10 +97,10 @@
     "    rows.append([f'Slowest {name}'] + __format_activity(Activities.get_slowest_by_sport(garmin_act_db, display_activity)))\n",
     "    rows.append([f'Longest {name}'] + __format_activity(Activities.get_longest_by_sport(garmin_act_db, display_activity)))\n",
     "\n",
-    "doc.add_header(\"Interesting Activities\", 3)\n",
+    "doc.add_heading(\"Interesting Activities\", 3)\n",
     "doc.add_table(['What', 'Id', 'Name', 'Type', 'Sport', f'Distance ({distance_units})', 'Elapsed Time', f'Speed ({unit_strings[fitfile.units.UnitTypes.speed]})', f'Pace ({unit_strings[fitfile.units.UnitTypes.pace]})', 'Calories'], rows)\n",
     "\n",
-    "doc.add_header(\"Courses\", 3)\n",
+    "doc.add_heading(\"Courses\", 3)\n",
     "courses = Activities.get_col_distinct(garmin_act_db, Activities.course_id)\n",
     "doc.add_paragraph(str(courses))\n",
     "\n",

Jupyter/activity.ipynb

@@ -26,7 +26,7 @@
     "\n",
     "activity_id = input('Enter the id of the activity you would like to display')\n",
     "\n",
-    "doc = snakemd.new_doc(\"activity\")\n",
+    "doc = snakemd.new_doc()\n",
     "\n",
     "db_params_dict = ConfigManager.get_db_params()\n",
     "garmin_db = GarminDb(db_params_dict)\n",
@@ -39,11 +39,11 @@
     "\n",
     "activity = Activities.get(garmin_act_db, activity_id)\n",
     "\n",
-    "doc.add_header(activity.name)\n",
+    "doc.add_heading(activity.name)\n",
     "if activity.description:\n",
     "    doc.add_paragraph(activity.description)\n",
     "\n",
-    "doc.add_header(\"Summary\", 3)\n",
+    "doc.add_heading(\"Summary\", 3)\n",
     "start_loc = Location(activity.start_lat , activity.start_long)\n",
     "end_loc = Location(activity.stop_lat , activity.stop_long)\n",
     "doc.add_table(\n",
@@ -60,7 +60,7 @@
     "    ]\n",
     ")\n",
     "\n",
-    "doc.add_header(\"Laps\", 3)\n",
+    "doc.add_heading(\"Laps\", 3)\n",
     "laps = ActivityLaps.get_activity(garmin_act_db, activity_id)\n",
     "lap_stats = []\n",
     "for lap in laps:\n",
@@ -80,7 +80,7 @@
     "    lap_stats\n",
     ")\n",
     "\n",
-    "doc.add_header(\"Time In Heart Rate Zones\", 3)\n",
+    "doc.add_heading(\"Time In Heart Rate Zones\", 3)\n",
     "doc.add_table(\n",
     "    ['Zone', 'HR Threshold', \"Time\"],\n",
     "    [\n",
@@ -91,7 +91,7 @@
     "        [\"5\", activity.hrz_5_hr, activity.hrz_5_time],\n",
     "    ])\n",
     "\n",
-    "doc.add_header(\"Training Effect\", 3)\n",
+    "doc.add_heading(\"Training Effect\", 3)\n",
     "doc.add_table(\n",
     "    ['Type', 'Rating'],\n",
     "    [\n",
@@ -105,7 +105,7 @@
     "    for device_entry in device_entries:\n",
     "        device = Device.get(garmin_db, device_entry.device_serial_number)\n",
     "        device_rows.append([device.manufacturer.name, device.product, device.device_type, device.serial_number, format_string(device.hardware_version)])\n",
-    "    doc.add_header(\"Devices\", 3)\n",
+    "    doc.add_heading(\"Devices\", 3)\n",
     "    doc.add_table(['Manufacturer', 'Product', 'Type', 'Serial Number', 'Hardware Version'], device_rows)\n",
     "\n",
     "display(Markdown(str(doc)))\n",

Jupyter/checkup.ipynb

@@ -21,18 +21,18 @@
     "from garmindb import ConfigManager\n",
     "from garmindb.garmindb import GarminDb, Device, DeviceInfo, ActivitiesDb, Activities, ActivityLaps, ActivityRecords, StepsActivities\n",
     "\n",
-    "doc = snakemd.new_doc(\"checkup\")\n",
+    "doc = snakemd.new_doc()\n",
     "\n",
     "db_params_dict = ConfigManager.get_db_params()\n",
     "\n",
     "garmin_db = GarminDb(db_params_dict)\n",
     "\n",
-    "checkup = garmindb.Checkup(paragraph_func=doc.add_paragraph, heading_func=doc.add_header)\n",
+    "checkup = garmindb.Checkup(paragraph_func=doc.add_paragraph, heading_func=doc.add_heading)\n",
     "\n",
-    "doc.add_header(\"Goals\", 2)\n",
+    "doc.add_heading(\"Goals\", 2)\n",
     "checkup.goals()\n",
     "\n",
-    "doc.add_header(\"Devices with Low Batteries\", 2)\n",
+    "doc.add_heading(\"Devices with Low Batteries\", 2)\n",
     "\n",
     "devices = Device.get_all(garmin_db)\n",
     "for device in devices:\n",

Jupyter/course.ipynb

@@ -23,11 +23,11 @@
     "from jupyter_funcs import format_number\n",
     "\n",
     "\n",
-    "doc = snakemd.new_doc(\"checkup\")\n",
+    "doc = snakemd.new_doc()\n",
     "\n",
     "course_id = input('Enter the id of a course to summarize')\n",
     "\n",
-    "doc.add_header(f\"Analysis for Course {course_id}\", 2)\n",
+    "doc.add_heading(f\"Analysis for Course {course_id}\", 2)\n",
     "\n",
     "db_params_dict = ConfigManager.get_db_params()\n",
     "\n",

Jupyter/daily.ipynb

@@ -26,8 +26,8 @@
     "def __render_day(garmin_sum_db, graph, date):\n",
     "    day = DaysSummary.get_day(garmin_sum_db, date)\n",
     "    if day:\n",
-    "        doc = snakemd.new_doc(\"garmin\")\n",
-    "        doc.add_header(f\"Summary of {date}\")\n",
+    "        doc = snakemd.new_doc()\n",
+    "        doc.add_heading(f\"Summary of {date}\")\n",
     "        doc.add_table(['Weight', 'Resting HR', 'Max HR', 'Waking Avg RR', 'Steps', 'Floors', 'Intensity Mins', 'Calories', 'Sleep', 'REM Sleep', 'Stress'],\n",
     "            [\n",
     "                [format_number(day.weight_avg), day.rhr_avg, day.hr_max, day.rr_waking_avg, day.steps, format_number(day.floors, 1),\n",

Jupyter/garmin.ipynb

@@ -21,9 +21,9 @@
     "unit_strings = fitfile.units.unit_strings[measurement_system]\n",
     "distance_units = unit_strings[fitfile.units.UnitTypes.distance_long]\n",
     "\n",
-    "doc = snakemd.new_doc(\"garmin\")\n",
+    "doc = snakemd.new_doc()\n",
     "\n",
-    "doc.add_header(\"GarminDb Statistics\")\n",
+    "doc.add_heading(\"GarminDb Statistics\")\n",
     "doc.add_paragraph(\"Metadata for data in the database.\")\n",
     "\n",
     "file_stats = [\n",

Jupyter/jupyter_funcs.py

@@ -39,4 +39,4 @@ def format_weight(distance, digits=1):
 
 def linked_location(location):
     """Return a location as markdown formatted linked text."""
-    return snakemd.InlineText(location.display(), location.to_google_maps_url())
+    return snakemd.Inline(location.display(), location.to_google_maps_url())

Jupyter/monitoring.ipynb

@@ -32,9 +32,9 @@
     "unit_strings = fitfile.units.unit_strings[measurement_system]\n",
     "distance_units = unit_strings[fitfile.units.UnitTypes.distance_long]\n",
     "\n",
-    "doc = snakemd.new_doc(\"monitoring\")\n",
+    "doc = snakemd.new_doc()\n",
     "\n",
-    "doc.add_header(\"Monitoring Statistics\")\n",
+    "doc.add_heading(\"Monitoring Statistics\")\n",
     "doc.add_paragraph(\"Analysis of all monitoring data in the database.\")\n",
     "\n",
     "def __get_col_stats(table, col, name, ignore_le_zero=False, time_col=False):\n",
@@ -90,7 +90,7 @@
     "    months = Monitoring.get_month_names(garmin_mon_db, year)\n",
     "    doc.add_paragraph(f\"{year} Months with data ({len(months)}): {months}\")\n",
     "\n",
-    "doc.add_header(\"Monitoring Records Coverage\", 3)\n",
+    "doc.add_heading(\"Monitoring Records Coverage\", 3)\n",
     "doc.add_paragraph(\"This shows periods that data has been downloaded for. \"\n",
     "                    \"Not seeing data for days you know Garmin has data? \"\n",
     "                    \"Change the starting day and the number of days in GarminConnectConfig.json and do a full download.\")\n",
@@ -99,7 +99,7 @@
     "doc.add_paragraph(f\"Monitoring Years with data ({len(years)}): {years}\")\n",
     "total_days = 0\n",
     "for year in years:\n",
-    "    doc.add_header(str(year), 4)\n",
+    "    doc.add_heading(str(year), 4)\n",
     "    __get_monitoring_months(year)\n",
     "    total_days += __get_monitoring_days(year)\n",
     "doc.add_paragraph(f\"Total days with monitoring data: {total_days}\")\n",

Jupyter/requirements.txt

@@ -1,2 +1,2 @@
-snakemd
+snakemd~=2.0.0
 pandas

Jupyter/summary.ipynb

@@ -46,8 +46,8 @@
     "    years_data.append([year, format_number(year_data.rhr_avg), format_number(year_data.rhr_min), format_number(year_data.rhr_max),\n",
     "                       format_number(year_data.hr_avg), format_number(year_data.hr_min), format_number(year_data.hr_max)])\n",
     "\n",
-    "doc = snakemd.new_doc(\"heart_rate\")\n",
-    "doc.add_header(\"Heart Rate\", 3)\n",
+    "doc = snakemd.new_doc()\n",
+    "doc.add_heading(\"Heart Rate\", 3)\n",
     "doc.add_table(['Year', 'Avg Resting HR', 'Min Resting HR', 'Max Resting HR', 'Avg HR', 'Min HR', 'Max HR'], years_data)\n",
     "display(Markdown(str(doc)))\n",
     "graph.graph_activity('hr', days=days_to_display)"
@@ -81,8 +81,8 @@
     "    year_data = YearsSummary.get_year(garmin_sum_db, year)\n",
     "    years_data.append([year, year_data.steps, year_data.steps_goal, format_number((year_data.steps_goal / year_data.steps) * 100.0)])\n",
     "\n",
-    "doc = snakemd.new_doc(\"steps\")\n",
-    "doc.add_header(\"Steps\", 3)\n",
+    "doc = snakemd.new_doc()\n",
+    "doc.add_heading(\"Steps\", 3)\n",
     "doc.add_table(['Year', 'Steps', 'Steaps Goal', 'Steps Goal %'], years_data)\n",
     "display(Markdown(str(doc)))\n",
     "graph.graph_activity('steps')"
@@ -100,8 +100,8 @@
     "    year_data = YearsSummary.get_year(garmin_sum_db, year)\n",
     "    years_data.append([year, format_number(year_data.weight_avg), format_number(year_data.weight_min), format_number(year_data.weight_max)])\n",
     "\n",
-    "doc = snakemd.new_doc(\"weight\")\n",
-    "doc.add_header(\"Weight\", 3)\n",
+    "doc = snakemd.new_doc()\n",
+    "doc.add_heading(\"Weight\", 3)\n",
     "doc.add_table(['Year', 'Avg Weight', 'Min Weight', 'Max Weight'], years_data)\n",
     "display(Markdown(str(doc)))\n",
     "graph.graph_activity('weight', days=days_to_display)"