Setup pytest and github actions for testing and release #21
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
- Added a pyproject.toml for defining build isolation. - Added a setup.cfg and moved almost all of package configuration to there. - Made setup.py as bare bones as possible. Still includes extra_requires though. - Added some default configuration options for pytest, flake8, mypy, and isort. - Setup SCM versioning in pyproject.toml and added modeci_mdf/version.py to gitignore to prevent it from getting checked into the repo.
Closed
See for .pre-commit-config.yaml for all installed hooks. Currently, I have disabled black formatting, flake8, isort, and mypy.
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.
I tried to make pytests for most of the functionality that is currently tested in testAll.sh There is still a bunch more that need to be done though. Some are set to expected fail as well, but these are minor issues, see the reasons.
I also made some minor changes to how the package is organized. This is to follow more modern python packaging trends. I moved almost everything out of setup.py and put it into setup.cfg instead. I added a pyproject.toml for setting up build isolation and scm versioning. The scm versioning integrating with setuptools will make it easy to publish new releases to pypi with correct version. We just need to tag a release on GitHub with the semantic version (e.g. v0.1.0) and this will trigger a github action that runs tests and pushes to pypi if all goes well. Do we have a pypi project setup, if so we just need to add the API key to the repo's secrets.