README: document running the tests locally#1221
Open
drnic wants to merge 1 commit into
Open
Conversation
peterbarker
reviewed
Jun 22, 2026
drnic
force-pushed
the
docs/running-tests
branch
2 times, most recently
from
7f6005f to
1ae4385
Compare
peterbarker
reviewed
Jun 22, 2026
drnic
force-pushed
the
docs/running-tests
branch
from
1ae4385 to
796a026
Compare
Add a 'Running the tests' section showing how to fetch the message definitions and run pytest, mirroring CI, plus the PYTHONPATH needed so the local checkout is imported as the pymavlink package.
drnic
force-pushed
the
docs/running-tests
branch
from
796a026 to
4190f97
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
The README explains how to install pymavlink but not how to run the test suite locally. Running it from a bare checkout has two non-obvious requirements, so this documents them.
If there is a better/preferred way to setup for local development, let me know and I'll update PR. This is how I got it working.