Organize requirements.txt

[iamEAP]

What / Why

Python dependencies are hard. Especially when the package you're publishing is sort of a weird hybrid between "library" (where one should not pin things!) and an end-product (where reproducibility is very important, and therefore one should definitely pin things).

This change doesn't actually change any of the resolved dependencies (as of today). But it attempts to organize things into logical groups:

1. Dependencies that define compatible operating environments (e.g. mkdocs and markdown)
2. Dependencies that we reflect back out as features of our own package (e.g. mdx sane lists)
3. Dependencies that are like category 1, except they're only in place temporarily to work around an underlying python dependency issue. (We no longer have these, but we were carrying around a couple for a long time see chore(deps): remove dependency pyparsing #91 & chore(deps): update dependency jinja2 to v3.1.2 #78)

So that we can more easily reason about dependency updates from renovate.

[camilaibs]

Thanks for arranging the dependencies in a way that helps us review the changes here, especially for the pinned group, which are critical dependencies.

[emmaindal]

I see that markdown_inline_graphviz_extension>=1.1.1,<2.0 was introduced as part of this PR #74 after this comment #74 (review)

@iswariyam I talked to @iamEAP and we're a little concerned about the open-endedness of themarkdown_inline_graphviz_extension version constraint...
How about combining what we did with the markdown constraint >=1.1.1,<2 or something?

Before we merge this I just want to make sure this is not still a concern?

[iamEAP]

I think moving the dependency from an extract version to a range was mistaken advice on my part in that PR. The hope is that splitting out the dependencies into these categories (as done in this PR) will help our future selves reason about ranges vs. exact versions.

[emmaindal]

Yes I agree with that, just wanted to double check with you both around that specific comment! So lets 🚢 it!

[emmaindal]

Yes I agree with that, just wanted to double check with you both around that specific comment! So lets 🚢 it!