DEV Community

Cover image for Why we made a Django release notes comparison tool

Why we made a Django release notes comparison tool

djangodoctor profile image Django Doctor ・1 min read

Django release notes are great. Very detailed. However, when updating across multiple releases such as 3.1.3 to 3.1.6 one would need to open the release notes for all 3 releases to get an idea of the changes:

That's why we made the Django release notes comparison productivity tool:

alt text

At a glance we can see the total changes.

Parsed to JSON

To achieve this we parsed Django's release notes to JSON.

An advantage of this functionality is the data is nice and machine readable. During the parsing we pull out metadata such as how many Django bugs are there in a particular Django Release:

alt text

This gives some context when we see a new Django version is available: do we need to upgrade now or can it wait.

Have a look:

Discussion (0)

Editor guide