Add nox and nox-uv for DX testing improvements #516
Merged
+375
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
TL;DR -- You (or an agent) can now run script/test.sh locally to verify that changes to the SDK work across all supported Python versions
Testing locally kinda sucks right now. #323 helped by making it possible to run
uv run --python=3.11to target a specific Python version (and recreate the environment effortlessly), but it's still a manual process.This change extends that improvement by adding nox and nox-uv for improved multi-version Python testing.
With this change, local devs will be able to:
scripts/test.shscript that means you don't even need to remember the syntaxOne limitation is that
uv-noxspecifically doesn't work on versions of Python < 3.9, but thats' for the contributor, not the library consumer. Since that's EOL anyways, it's safe to assume that folks shouldn't be developing with that version of Python imo.One final note, this does not change the
ci.yamlfile, and it doesn't change that intentionally. A matrix strategy is still faster in CI and is working well. This is purely an improvement for the developer experience.Below is the experience / performance of running it after you have cached the first run (and have the dependencies in the nox environment for each version):
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.