Restructure project by flattening directories and add CI which runs tests with pytest #2
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
src/pydsol/core/ becomes pydsol tests/pydsol/core becomes tests This follows the best practice as documented in https://docs.python-guide.org/writing/structure/ and https://docs.pytest.org/en/7.1.x/explanation/goodpractices.html
Creates an initial CI configuration that runs the tests on Python 3.8, 3.9 and 3.10 and on Ubuntu, macOS and Windows in a sparse configuration. It uses pytests running the tests and the job is triggered on each push, pull request, weekly at Monday 06:00 UTC and when manually triggered.
|
@averbraeck What do you think? |
|
@averbraeck Congratulations on the 4.0 release! Let me know if you find any of these changes useful. If so, I will open a new PR with them, otherwise I will close this PR. |
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.
This PR does two things, in two commits:
src/pydsol/corebecomespydsoltests/pydsol/corebecomestestsThis makes running pytest as easy as running
python -m pytest. The CI configuration worked on the first try, which I can tell you rarely happens. Using a wide-adopted project structure also makes packaging (to PyPI for example) also a lot easier.Note that the CI already catched an interesting error: While Python 3.9 and 3.10 passes the tests perfectly fine, 3.8 won't work because a lot of
TypeError: 'type' object is not subscriptableerrors. As you probably know this has to do with Python 3.8 and earlier not supporting this type hinting functionality (link).This is not documented in the docs and not specified in a
python_requiresvariable, and can keep less experienced users stuck wondering why their code keeps producing errors and tests don't pass.Anyway, just a quick proof of concept, please let me know what you think of it and if you would like any changes.