Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add argparser #15

Merged
merged 3 commits into from
Feb 3, 2023
Merged

add argparser #15

merged 3 commits into from
Feb 3, 2023

Conversation

semuadmin
Copy link
Contributor

@semuadmin semuadmin commented Feb 2, 2023

pygnssutils Pull Request Template

Description

Update all CLI utilities to use standard Pythonargparse library for argument parsing. For example:

Previously:

  • gnssdump port=/dev/tty.usbmodem1101 baud=115200 timeout=5

Now:

  • gnssdump --port /dev/tty.usbmodem1101 --baudrate 115200 --timeout 5

For all CLI utilities, type -h for help. Refer to README for other examples.
The kwargs for the underlying Class constructors are unchanged.

Testing

Please test all changes, however trivial, against the supplied unittest suite tests/test_*.py e.g. by executing the tests/testsuite.py module or using your IDE's native Python unittest integration facilities. Please describe any test cases you have amended or added to this suite to maintain >= 99% code coverage.

Checklist:

  • My code follows the style guidelines of this project (see CONTRIBUTING.MD).
  • I have performed a self-review of my own code.
  • (if appropriate) I have cited my u-blox documentation source(s).
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • (if appropriate) I have added test cases to the tests/test_*.py unittest suite to maintain >= 99% code coverage.
  • I have tested my code against the full tests/test_*.py unittest suite.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I understand and acknowledge that the code will be published under a BSD 3-Clause license.

@semuadmin semuadmin self-assigned this Feb 2, 2023
@semuadmin semuadmin added the enhancement New feature or request label Feb 2, 2023
@semuadmin semuadmin merged commit 7eeea94 into main Feb 3, 2023
@semuadmin semuadmin deleted the use-argparse branch February 3, 2023 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant