feat: Prepare For Multi-Command CLI Interface #121
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the CLI tool for additional commands by introducing a subcommand structure and updating tests accordingly.
- Modified the tests to invoke the new "xml2json" subcommand.
- Added a dedicated module for the xml2json command and integrated it via the commands package.
- Refactored the CLI entrypoint to support a multi-command interface.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| unittests/test_cli.py | Updated test invocations to use the "xml2json" subcommand. |
| src/fundamend/commands/xml2json.py | Added the xml2json command implementation for converting XML to JSON. |
| src/fundamend/commands/init.py | Created a central commands module that registers the xml2json command. |
| src/fundamend/cli.py | Refactored the CLI entrypoint to delegate to the new commands module. |
Comment on lines
+38
to
+40
| print(f"Successfully converted {xml_file_path} file to JSON {json_file_path}") | ||
| return json_file_path | ||
|
|
There was a problem hiding this comment.
[nitpick] Consider replacing print() with typer.echo() for consistent CLI output handling which integrates better with Typer's logging and testing facilities.
Suggested change
| print(f"Successfully converted {xml_file_path} file to JSON {json_file_path}") | |
| return json_file_path | |
| typer.echo(f"Successfully converted {xml_file_path} file to JSON {json_file_path}") |
Copilot uses AI. Check for mistakes.
hf-kklein
reviewed
Apr 15, 2025
|
|
||
| app = typer.Typer(name="xml2json", help="Convert XML(s) by BDEW to JSON(s)") | ||
| app = typer.Typer(name="fundamend", help="CLI tool to work with XML files by BDEW", no_args_is_help=True) |
There was a problem hiding this comment.
please adapt the readme accordingly: https://github.com/Hochfrequenz/xml-fundamend-python?tab=readme-ov-file#cli-tool-f%C3%BCr-xml%EF%B8%8Fjson-konvertierung
hf-kklein
approved these changes
Apr 15, 2025
hf-kklein
changed the title
|
fixed README in 629ae3d |
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 prepares the fundamend cli tool for further commands.
The current xml2json command is now