vdotz 0.1.0__tar.gz

vdotz-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vdotz-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: vdotz
+Version: 0.1.0
+Summary: Running pace and race-time tools.
+Author: m09
+Author-email: m09 <142691+m09@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: fit-tool>=0.9.16
+Requires-Dist: garmin-fit-sdk>=21.221.0
+Requires-Dist: niquests>=3.17.0
+Requires-Dist: python-dotenv>=1.2.4
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# `vdotz`
+
+Running pace and race-time tools, built on Jack Daniels' VDOT, with workout
+templates synced to intervals.icu.
+
+```sh
+vdotz vdot 5km 19:10            # VDOT of a race and equivalent race times
+vdotz paces                     # usual reference paces at the current VDOT
+vdotz paces marathon "10km+3%"  # any pace of the templates syntax
+vdotz --vdot 48.3 paces "4:39*95%"
+vdotz week                      # intervals / easy / rests of the current week
+vdotz week -1 --type Ride       # previous week, for another activity type
+vdotz course race.gpx -D marathon marathon 3:05:00  # even-effort splits
+vdotz fit strength/*.toml -o GARMIN/NewFiles  # strength sessions for Garmin
+vdotz watch                     # strength + non-easy plan workouts to the watch
+```
+
+## Installation
+
+```sh
+uv tool install vdotz
+```
+
+From a clone of the repository, to work on it:
+
+```sh
+uv tool install --editable .
+vdotz link       # see below
+```
+
+Files follow the XDG base directory specification:
+
+```
+~/.config/vdotz/             # $XDG_CONFIG_HOME/vdotz
+├── config.toml              # athlete_id = "i…" and vdot = 52.3, or a [test] table
+└── .env                     # INTERVALS_API_KEY=…
+~/.local/share/vdotz/        # $XDG_DATA_HOME/vdotz, or -d DIRECTORY
+├── 🏃 NSM/                  # one subdirectory per intervals.icu library folder
+│   └── intervalles-courts.toml
+└── 🏃 NSM plan.toml         # one file per intervals.icu plan
+```
+
+They are versioned in this repository as `config/` (where `.env` is ignored by
+git) and `workouts/`: `vdotz link` links the two locations to them, so that
+`vdotz` works from any directory. `--vdot` overrides the configured VDOT.
+
+## Course paces
+
+`vdotz course` reads a GPX track and prints the paces of an even effort over
+the course: per kilometer (with the cumulative time and the waypoints, such as
+feed stations), then over each climb and descent. Goals are flat paces in the
+`paces` syntax (`marathon` by default, `4:20`, `semi+2%`), or finish times
+(`3:05:00`). `-D` scales the track to the official distance, since GPS tracks
+are rarely exact.
+
+The track is resampled every 20 m and its elevation smoothed over 200 m, as raw
+GPS elevations count much more climbing than there is. Each segment's pace is
+the flat pace times `1 + 0.033·g` uphill, `1 + 0.018·max(g, -4)` downhill, for a
+grade of `g`%. A waypoint near a road that the course takes twice gets both
+passes.
+
+## Strength sessions
+
+`vdotz fit` converts strength sessions (`strength/` in this repository) to
+Garmin strength workouts, as FIT files. Copied to `GARMIN/NewFiles` on the
+watch, they show up in its workouts.
+
+```toml
+name = "Muscu mardi"
+warmup = "5-10', puis séries de montée en charge"  # open step, optional
+
+[[blocks]]
+sets = 3      # defaults to 1
+rest = "3'"   # after each set, optional
+exercises = [
+    { exercise = "deadlift/barbell_deadlift", name = "Soulevé de terre", reps = 5, weight = 102 },
+    { exercise = "plank/side_plank", name = "Gainage latéral", duration = "30s", unilateral = true },
+]
+```
+
+A block with several exercises is a superset. `exercise` is a category of the
+FIT profile, optionally followed by an exercise of this category, in lower case
+(see `ExerciseCategory` and the `…ExerciseName` enums of `fit_tool`). `name` is
+the step name; `weight` is in kg.
+
+An exercise with `unilateral = true` becomes two steps, left then right, each
+with its `reps` or `duration`: a timed circuit then gives its full time to each
+side. The side is at the start of the step notes. Timed sides are separated by
+5 s of rest, to change sides.
+
+## Garmin watch
+
+`vdotz watch` copies to a Garmin watch plugged in over USB the strength
+sessions and the workouts of the plans, except easy runs (`E …`), which are
+just a time. The running workouts are converted to FIT by intervals.icu, from
+the library: run `vdotz sync` first after changing a template (a warning
+says so). Strength sessions are optional: without a `strength` directory next
+to the workouts, only the running workouts are copied.
+
+The watch is mounted over MTP once opened in the file manager: the files go to
+`GARMIN/NewFiles`, found under `/run/user/$UID/gvfs`, and are imported when the
+watch is unplugged. The previous versions, which the watch would keep beside
+the new ones, are removed from `GARMIN/Workouts` first. `-o` gives another
+directory.
+
+## Merging activities
+
+`vdotz merge` merges the activities of a day into a single FIT file, ready to
+be uploaded to Garmin Connect, for a run split by stopping the watch by mistake.
+It downloads the original files from intervals.icu, and the time between two
+activities becomes a timer pause.
+
+```sh
+vdotz merge                                 # today's runs
+vdotz merge 2026-11-05 -t Ride -o ride.fit  # another day and activity type
+vdotz merge 2026-11-05 -a i123 -a i456      # only these activities
+```
+
+It lists the activities it finds: if the merged file already came back to
+intervals.icu, they overlap, and `-a` chooses the originals. Records are kept as
+they are, and the session is computed from those of the activities, with a few
+approximations: the normalized power is a mean, the training effects are the
+highest ones, and the feel and RPE are those of the last activity. Garmin splits
+are dropped. See `merge.py` for the details.
+
+Delete the originals afterwards, on Garmin Connect and on intervals.icu, or the
+load of the day is counted twice.
+
+## Elevation correction
+
+intervals.icu can replace the altitude recorded by the watch with the one of
+online maps. On flat routes this adds climbing that doesn't exist: 154 m instead
+of 9 m around the Île de Nantes. It also changes the training load, which follows
+the pace load.
+
+`vdotz elevation` turns the correction off on recent activities, and prints
+their elevation gain before and after. The gain is recalculated straight away.
+Activities already corrected are left alone, so it can be run at any time.
+
+```sh
+vdotz elevation --dry-run        # list the runs of the last 30 days
+vdotz elevation                  # turn the correction off
+vdotz elevation --days 90 -t Ride # another period and activity type
+```
+
+## Workout templates
+
+`vdotz` keeps intervals.icu workouts as local files whose paces are derived
+from a VDOT, and pushes them to intervals.icu on demand (e.g. after a test).
+
+```toml
+# config.toml
+athlete_id = "i364734"
+
+[test]
+distance = "5km"
+time = "19:10"
+```
+
+```toml
+# 🏃 NSM/intervalles-courts.toml
+name = "Intervalles courts"
+type = "Run"
+description = '''
+11x
+- 3' {60'+1%}-{60'} Pace intensity=interval
+- 1' intensity=rest
+'''
+```
+
+Descriptions use the intervals.icu workout builder syntax. Placeholders between
+braces are replaced by the maximal pace over a duration (`{1h}`, `{90'}`) or a
+distance (`{10km}`, `{semi}`, `{marathon}`), by the pace at VO2max (`{mas}`), or
+by a literal pace (`{4:39}`). Adjustments apply from left to right: `*65%` for
+65% of the speed, `+1%` for a pace 1% slower, `+2'` for a pace 2 min/km slower
+(e.g. `{mas*65%+2'}`). Each placeholder is a single pace: ranges join two
+placeholders (e.g. `{60'+1%}-{60'}`).
+
+`vdotz week` classifies the planned steps by intensity: `interval` steps are
+intervals, `rest` steps are rests, and everything else is easy running.
+
+The API key is read from the `INTERVALS_API_KEY` environment variable, or from a
+`.env` file in the current directory, one of its parents, or the configuration
+directory.
+
+```sh
+vdotz pull "🏃 NSM"             # bootstrap from an existing folder
+vdotz render                    # preview the computed paces
+vdotz sync --dry-run            # show the diff with intervals.icu
+vdotz sync --calendar           # update the library and planned workouts
+```
+
+## Plans
+
+A TOML file at the root of the workouts directory is an intervals.icu plan, named
+after the file. It lists workouts week by week, from Monday to Sunday, with `""`
+for rest days. Workouts can come from any folder, as long as their names are
+unique:
+
+```toml
+# 🏃 NSM plan.toml
+weeks = [
+    ["Jog", "Intervalles courts", "", "Intervalles moyens", "", "Jog", "Sortie longue"],
+]
+```
+
+`vdotz sync` creates the plan and keeps its workouts identical to the
+templates, matched by day: plan workouts on rest days are deleted. Plans are
+applied to the calendar from intervals.icu, after which `sync --calendar` keeps
+the planned workouts up to date.
+
+## Releasing
+
+1. `uv run bumpver update --minor` (or `--patch`, `--major`): bumps, commits, tags
+   and pushes.
+2. `uv run doit publish`: builds and uploads to PyPI with the token of
+   `creds.env`, a gitignored file at the repository's root holding one line,
+   `export UV_PUBLISH_TOKEN=pypi-...`, readable by you only (`chmod 400`).

vdotz-0.1.0/README.md

@@ -0,0 +1,218 @@
+# `vdotz`
+
+Running pace and race-time tools, built on Jack Daniels' VDOT, with workout
+templates synced to intervals.icu.
+
+```sh
+vdotz vdot 5km 19:10            # VDOT of a race and equivalent race times
+vdotz paces                     # usual reference paces at the current VDOT
+vdotz paces marathon "10km+3%"  # any pace of the templates syntax
+vdotz --vdot 48.3 paces "4:39*95%"
+vdotz week                      # intervals / easy / rests of the current week
+vdotz week -1 --type Ride       # previous week, for another activity type
+vdotz course race.gpx -D marathon marathon 3:05:00  # even-effort splits
+vdotz fit strength/*.toml -o GARMIN/NewFiles  # strength sessions for Garmin
+vdotz watch                     # strength + non-easy plan workouts to the watch
+```
+
+## Installation
+
+```sh
+uv tool install vdotz
+```
+
+From a clone of the repository, to work on it:
+
+```sh
+uv tool install --editable .
+vdotz link       # see below
+```
+
+Files follow the XDG base directory specification:
+
+```
+~/.config/vdotz/             # $XDG_CONFIG_HOME/vdotz
+├── config.toml              # athlete_id = "i…" and vdot = 52.3, or a [test] table
+└── .env                     # INTERVALS_API_KEY=…
+~/.local/share/vdotz/        # $XDG_DATA_HOME/vdotz, or -d DIRECTORY
+├── 🏃 NSM/                  # one subdirectory per intervals.icu library folder
+│   └── intervalles-courts.toml
+└── 🏃 NSM plan.toml         # one file per intervals.icu plan
+```
+
+They are versioned in this repository as `config/` (where `.env` is ignored by
+git) and `workouts/`: `vdotz link` links the two locations to them, so that
+`vdotz` works from any directory. `--vdot` overrides the configured VDOT.
+
+## Course paces
+
+`vdotz course` reads a GPX track and prints the paces of an even effort over
+the course: per kilometer (with the cumulative time and the waypoints, such as
+feed stations), then over each climb and descent. Goals are flat paces in the
+`paces` syntax (`marathon` by default, `4:20`, `semi+2%`), or finish times
+(`3:05:00`). `-D` scales the track to the official distance, since GPS tracks
+are rarely exact.
+
+The track is resampled every 20 m and its elevation smoothed over 200 m, as raw
+GPS elevations count much more climbing than there is. Each segment's pace is
+the flat pace times `1 + 0.033·g` uphill, `1 + 0.018·max(g, -4)` downhill, for a
+grade of `g`%. A waypoint near a road that the course takes twice gets both
+passes.
+
+## Strength sessions
+
+`vdotz fit` converts strength sessions (`strength/` in this repository) to
+Garmin strength workouts, as FIT files. Copied to `GARMIN/NewFiles` on the
+watch, they show up in its workouts.
+
+```toml
+name = "Muscu mardi"
+warmup = "5-10', puis séries de montée en charge"  # open step, optional
+
+[[blocks]]
+sets = 3      # defaults to 1
+rest = "3'"   # after each set, optional
+exercises = [
+    { exercise = "deadlift/barbell_deadlift", name = "Soulevé de terre", reps = 5, weight = 102 },
+    { exercise = "plank/side_plank", name = "Gainage latéral", duration = "30s", unilateral = true },
+]
+```
+
+A block with several exercises is a superset. `exercise` is a category of the
+FIT profile, optionally followed by an exercise of this category, in lower case
+(see `ExerciseCategory` and the `…ExerciseName` enums of `fit_tool`). `name` is
+the step name; `weight` is in kg.
+
+An exercise with `unilateral = true` becomes two steps, left then right, each
+with its `reps` or `duration`: a timed circuit then gives its full time to each
+side. The side is at the start of the step notes. Timed sides are separated by
+5 s of rest, to change sides.
+
+## Garmin watch
+
+`vdotz watch` copies to a Garmin watch plugged in over USB the strength
+sessions and the workouts of the plans, except easy runs (`E …`), which are
+just a time. The running workouts are converted to FIT by intervals.icu, from
+the library: run `vdotz sync` first after changing a template (a warning
+says so). Strength sessions are optional: without a `strength` directory next
+to the workouts, only the running workouts are copied.
+
+The watch is mounted over MTP once opened in the file manager: the files go to
+`GARMIN/NewFiles`, found under `/run/user/$UID/gvfs`, and are imported when the
+watch is unplugged. The previous versions, which the watch would keep beside
+the new ones, are removed from `GARMIN/Workouts` first. `-o` gives another
+directory.
+
+## Merging activities
+
+`vdotz merge` merges the activities of a day into a single FIT file, ready to
+be uploaded to Garmin Connect, for a run split by stopping the watch by mistake.
+It downloads the original files from intervals.icu, and the time between two
+activities becomes a timer pause.
+
+```sh
+vdotz merge                                 # today's runs
+vdotz merge 2026-11-05 -t Ride -o ride.fit  # another day and activity type
+vdotz merge 2026-11-05 -a i123 -a i456      # only these activities
+```
+
+It lists the activities it finds: if the merged file already came back to
+intervals.icu, they overlap, and `-a` chooses the originals. Records are kept as
+they are, and the session is computed from those of the activities, with a few
+approximations: the normalized power is a mean, the training effects are the
+highest ones, and the feel and RPE are those of the last activity. Garmin splits
+are dropped. See `merge.py` for the details.
+
+Delete the originals afterwards, on Garmin Connect and on intervals.icu, or the
+load of the day is counted twice.
+
+## Elevation correction
+
+intervals.icu can replace the altitude recorded by the watch with the one of
+online maps. On flat routes this adds climbing that doesn't exist: 154 m instead
+of 9 m around the Île de Nantes. It also changes the training load, which follows
+the pace load.
+
+`vdotz elevation` turns the correction off on recent activities, and prints
+their elevation gain before and after. The gain is recalculated straight away.
+Activities already corrected are left alone, so it can be run at any time.
+
+```sh
+vdotz elevation --dry-run        # list the runs of the last 30 days
+vdotz elevation                  # turn the correction off
+vdotz elevation --days 90 -t Ride # another period and activity type
+```
+
+## Workout templates
+
+`vdotz` keeps intervals.icu workouts as local files whose paces are derived
+from a VDOT, and pushes them to intervals.icu on demand (e.g. after a test).
+
+```toml
+# config.toml
+athlete_id = "i364734"
+
+[test]
+distance = "5km"
+time = "19:10"
+```
+
+```toml
+# 🏃 NSM/intervalles-courts.toml
+name = "Intervalles courts"
+type = "Run"
+description = '''
+11x
+- 3' {60'+1%}-{60'} Pace intensity=interval
+- 1' intensity=rest
+'''
+```
+
+Descriptions use the intervals.icu workout builder syntax. Placeholders between
+braces are replaced by the maximal pace over a duration (`{1h}`, `{90'}`) or a
+distance (`{10km}`, `{semi}`, `{marathon}`), by the pace at VO2max (`{mas}`), or
+by a literal pace (`{4:39}`). Adjustments apply from left to right: `*65%` for
+65% of the speed, `+1%` for a pace 1% slower, `+2'` for a pace 2 min/km slower
+(e.g. `{mas*65%+2'}`). Each placeholder is a single pace: ranges join two
+placeholders (e.g. `{60'+1%}-{60'}`).
+
+`vdotz week` classifies the planned steps by intensity: `interval` steps are
+intervals, `rest` steps are rests, and everything else is easy running.
+
+The API key is read from the `INTERVALS_API_KEY` environment variable, or from a
+`.env` file in the current directory, one of its parents, or the configuration
+directory.
+
+```sh
+vdotz pull "🏃 NSM"             # bootstrap from an existing folder
+vdotz render                    # preview the computed paces
+vdotz sync --dry-run            # show the diff with intervals.icu
+vdotz sync --calendar           # update the library and planned workouts
+```
+
+## Plans
+
+A TOML file at the root of the workouts directory is an intervals.icu plan, named
+after the file. It lists workouts week by week, from Monday to Sunday, with `""`
+for rest days. Workouts can come from any folder, as long as their names are
+unique:
+
+```toml
+# 🏃 NSM plan.toml
+weeks = [
+    ["Jog", "Intervalles courts", "", "Intervalles moyens", "", "Jog", "Sortie longue"],
+]
+```
+
+`vdotz sync` creates the plan and keeps its workouts identical to the
+templates, matched by day: plan workouts on rest days are deleted. Plans are
+applied to the calendar from intervals.icu, after which `sync --calendar` keeps
+the planned workouts up to date.
+
+## Releasing
+
+1. `uv run bumpver update --minor` (or `--patch`, `--major`): bumps, commits, tags
+   and pushes.
+2. `uv run doit publish`: builds and uploads to PyPI with the token of
+   `creds.env`, a gitignored file at the repository's root holding one line,
+   `export UV_PUBLISH_TOKEN=pypi-...`, readable by you only (`chmod 400`).