Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tests: use package metadata as source of README test data. #1162

Merged
merged 4 commits into from
Jul 11, 2024

Conversation

jayaddison
Copy link
Collaborator

This works for me locally on Py3.11; I'm not 100% certain whether this is entirely backwards compatible through Py3.8.

May resolve #1160.

@jayaddison
Copy link
Collaborator Author

@rmdluo @jknndy the README.rst file isn't included in the built recipe_scrapers Python library package -- however, the same metadata is available in the package description, and the test_includes unit test (the one that checks for all of the scraper hyperlinks) does work using that text instead.

What do you think about this as a potential change to read the content from the package metadata?

@jayaddison
Copy link
Collaborator Author

This should be a reversible decision, so I'm going to move ahead with it in order to resolve #1160. If we later discover that we have to backtrack/revert, that's OK.

@jayaddison jayaddison merged commit 5a87d80 into main Jul 11, 2024
19 checks passed
@jayaddison jayaddison deleted the issue-1160/test-readme-using-package-description branch July 11, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Test fail with missing README.rst
1 participant