Solves #194 - Root module runtime
#195
Merged
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
The commit proposes a solution for issue asam-ev#194, which underlines how root module has common name, which may imply name clashes with other existing modules in python ecosystem. The actual implementation: * renames `runtime` module in `qc_framework` module. `runtime` is a submodule for `qc_framework`. The approach allows to introduce other required applications for successful execution of runtime directly, without maintaining multiple module. * `qc_runtime` script is preserved * `runtime` remains the principal executable of the package, and can be launched also with `python -m qc_framework` (for users that do not have python scripts on PATH - in particular Windows users) * Documentation for the framework has been updated in order to reflect the changes * License banner are included for all source file * Github builders definition has been updated to reflect the changes * Dockerfiles have been updated to reflect the changes * All public methods have been documented * Wrong type hinting for model field validation has been corrected Signed-off-by: Matteo Ragni <[email protected]>
MatteoRagni
added
the
isState:New
3 tasks
|
I'm not the Python expert.... but it makes totally sense and personally I would directly approve. This is also CCB relevant. |
andreaskern74
added
the
isState:ForCCBReview
andreaskern74
approved these changes
Oct 7, 2024
hoangtungdinh
approved these changes
Oct 7, 2024
heuerfin
approved these changes
Oct 7, 2024
andreaskern74
added
isState:Integrated
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.
Description
The commit proposes a solution for issue #194, which underlines how root module has common name, which may imply name clashes with other existing modules in python ecosystem.
Main changes
runtimemodule inqc_frameworkmodule.runtimeis a submodule forqc_framework. The approach allows to introduce other required applications for successful execution of runtime directly, without maintaining multiple module, as required in review for JSON Formatter for Result file (C++ and Python versions). Adds py Text report and py GithubCI report #191.qc_runtimescript is preservedruntimeremains the principal executable of the package, and can be launched also withpython -m qc_framework(for users that do not have scripts directory on PATH - i.e., usually Windows users)How was the PR tested?
Notes
Required for complinting the work on #191