https://github.com/h4l/zwift-workout-file-reference
Reference documentation for the Zwift workout file format
https://github.com/h4l/zwift-workout-file-reference
cycling documentation fitness indoor training xml zwift zwo
Last synced: 4 months ago
JSON representation
Reference documentation for the Zwift workout file format
- Host: GitHub
- URL: https://github.com/h4l/zwift-workout-file-reference
- Owner: h4l
- License: other
- Created: 2019-05-18T14:51:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-22T07:58:44.000Z (over 4 years ago)
- Last Synced: 2025-04-24T06:16:09.226Z (6 months ago)
- Topics: cycling, documentation, fitness, indoor, training, xml, zwift, zwo
- Language: Python
- Size: 41 KB
- Stars: 77
- Watchers: 14
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zwift Workout File Reference
A project to create reference documentation for the XML elements and attributes
used in Zwift custom workout files.
The **[Zwift Workout File Reference is here](./zwift_workout_file_tag_reference.md)**
## Contributing
Many of the elements/attributes are not yet described. Help to improve the
descriptions would be great.
The reference is generated from two sources:
* Manually created descriptions and examples in
[descriptions.yaml](descriptions.yaml)
* Automatically generated data in [tag_attr_usage.json](tag_attr_usage.json)
* This data is generated by
[zwift_zwo_docs/analyze_zwo.py](zwift_zwo_docs/analyze_zwo.py) which
analyses Zwift workout files to find the elements/attributes they use.
* The `tag_attr_usage.json` committed here is the result of analysing all of
the workouts that come with Zwift. The workout files themselves can't be
committed here as they're copyrighted.
### How to contribute
You can add descriptions and examples to `descriptions.yaml`.
To re-generate `zwift_workout_file_tag_reference.md`, install Python 3.7, then:
```console
$ cd
$ pip install .
$ make
```
Commit changes to both, then submit a PR to this repo.