-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary Release 0.2.0 ### Why? Bugfixes, improving test coverage and code quality, and fixing the local notebook environment. ### How? - Install pysparkplug in the notebook image without git by using SETUPTOOLS_SCM_PRETEND_VERSION environment variable. - Add requirements/requirements.txt to .dockerignore so it can be used when installing pysparkplug in the notebook image. - Prep changelog for 0.2.0 - Update notebooks with results from the latest code. - Update notebooks/run.sh to also start the emqx message broker, and to clean up after itself using docker compose down. - Have unit tests queue the coverage session in noxfile.py if they run with coverage. - Remove invalid-enum-extension pylint error since we're now inheriting from StrEnum. - Added full test coverage for _topic.py in test_topic.py, and improved minimum coverage score. - Updated requirements files, pinning sphinx to 7.1.2 in docs.in since sphinx-notfound-page doesn't yet support 7.2 - Created a _constants.py module for shared constants between modules, and used it to create wildcard constants with convenient type annotation compatible with the Topic class. - Removed topic.to_str() since it is redundant with str(topic). - Added backports' implementation of StrEnum to _strenum.py to resolve bug with how the old implementation of StrEnum was rendering enums to string. - Fixewd bug with incorrect wildcards used for validating and creating topic components. - No longer importing Literal from typing_extensions since it is in Python 3.8. ## Checklist Most checks are automated, but a few aren't, so make sure to go through and tick them off, even if they don't apply. This checklist is here to help, not deter you. Remember, "Slow is smooth, and smooth is fast". - [X] **Unit tests** - Every input should have a test for it. - Every potential raised exception should have a test ensuring it is raised. - [x] **Documentation** - New functions/classes/etc. must be added to `docs/api.rst`. - Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated` [directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded). - The appropriate entry in `CHANGELOG.md` has been included in the "Unreleased" section, i.e. "Added", "Changed", "Deprecated", "Removed", "Fixed", or "Security". - [X] **Future work** - Future work should be documented in the contributor guide, i.e. `.github/CONTRIBUTING.md`. If you have any questions not answered by a quick readthrough of the [contributor guide](https://pysparkplug.mattefay.com/en/latest/contributor_guide.html), add them to this PR and submit it.
- Loading branch information
Showing
32 changed files
with
531 additions
and
106 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
Oops, something went wrong.