Documentation: Add required python version to docs and test deps. #125
Conversation
This file contains 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
When running `make test` for the first time on a machine not regularly used for building and testing python code chances are high that pytest and pytest-cov aren't installed. This add them as a dependency to requirements.txt. Also adding information on minimum python version to run the code. With python3.10 I ran into the error message `TypeError: Parameters to generic types must be types. Got <module 'github3.issues.event'` With python3.11 this error was gone.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When running
make testfor the first time on a machine not regularly used for building and testing python code chances are high that pytest and pytest-cov aren't installed. This add them as a dependency to requirements.txt.Also adding information on minimum python version to run the code. With python3.10 I ran into the error message
TypeError: Parameters to generic types must be types. Got <module 'github3.issues.event'With python3.11 this error was gone.
make lintand fix any issues that you have introducedmake testand ensure you have test coverage for the lines you are introducingbug,documentation,enhancement,infrastructure, orbreaking(<- the project doesn't let me change labels, likely as a contributor I don't have the karma to do that?)