Strava Swagger to Pydantic

This repository contains a Python script that is run in a GitHub Action that creates a Pydantic model from Strava's Swagger API definition.

The script fetches the swagger.json example response and generates a Pydantic model using Pydantics datamodel code generator.

The script runs via a nightly GitHub action cron job that can be found here. The action creates a new module called strava_model.py that represents the most recent version of Strava's swagger.json file. The action opens a pull request if any changes are found.

It's important to note that Strava's swagger.json, the online Strava online specification / docs and the actual JSON returns are not always (if ever) in perfect sync.

How to run this locally

1. First, make sure you have all of the necessary requirements installed. We are using the datamodel-code-generator package to generate the model.

pip install requirements.txt

2. Once the requirements are installed, you are ready to run the script.

This module takes one input environment variable - the name of the output module. You have two options for setting this variable:

Option 1: Set is as an environment variable

You can chose to store this value as an environment variable called MODEL_FILE on your computer.

To set the environment variable, run the command below in your favorite shell:

export MODEL_FILE="output_model.py"

Option 2: Define the filename in place

You can define the filename in place as follows:

# Run this in the terminal with your Python environment activated
$ MODEL_FILE="output_model.py" python swagger2pydantic.py

In the example above, the script will run, creating a new module called output_model.py in your current working directory.

When you run the command above, the output should look something like this:

➜ MODEL_FILE="output_model.py" python swagger2pydantic.py
INFO:__main__:Starting schema loading
INFO:__main__:Got schema for class(es) ActivityStats
INFO:__main__:Got schema for class(es) Fault, Error
INFO:__main__:Got schema for class(es) DetailedAthlete, SummaryAthlete, ClubAthlete, MetaAthlete
INFO:__main__:Got schema for class(es) Zones, HeartRateZoneRanges, PowerZoneRanges, ZoneRanges, ZoneRange, TimedZoneRange, TimedZoneDistribution, ActivityZone
INFO:__main__:Got schema for class(es) DetailedSegment, SummarySegment, ExplorerResponse, ExplorerSegment
INFO:__main__:Got schema for class(es) DetailedSegmentEffort, SummarySegmentEffort, SummaryPRSegmentEffort
INFO:__main__:Got schema for class(es) DetailedActivity, SummaryActivity, MetaActivity, UpdatableActivity, ClubActivity
INFO:__main__:Got schema for class(es) Lap