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

[BREAKING] X/Y coordinates can be given as input parameters (e.g. for testing!) & refactoring of GUI & CLI processing #99

Merged
merged 10 commits into from
Apr 7, 2022

Conversation

treee111
Copy link
Owner

@treee111 treee111 commented Mar 19, 2022

This PR…

  • makes it possible to provide X/Y coordinates via command line as input parameter to create the corresponding map

Considerations and implementations

This PR brings a foundation to implement #100 and #89 by

  • refactoring the argparse input coding to be future-proof
    • subparsers (and therefore subcommands) for GUI and CLI start of the tool
    • differentiate between the three possible primary inputs for CLI processing (country-name, X/Y coordinates, json file with tiles) in cli help and program coding

How to test

  1. run tool via CLI with one X/Y coordinate and multiple X/Y coordinates
    • one country involved
    • multiple countries involved
  2. run tool via CLI for a country
  3. run tool via GUI for a country
  4. check README and documentation

Pull Request Checklist

- to distinct between GUI and CLI processing clearer
- to be able to implement input of X/Y coordinates in the future
- incl. adjusting relevat unit tests
- functions to provide the functionality
- call of them
- tests
- country-name without "/" for X/Y coordinates
@treee111 treee111 added the enhancement New feature or request label Mar 19, 2022
@treee111 treee111 added this to the v1.2.0 milestone Mar 19, 2022
- in coding & tests
- launch config: malta as x/y + multiple x/y comb
@treee111 treee111 marked this pull request as ready for review April 7, 2022 13:41
@treee111 treee111 modified the milestones: v1.2.0, v2.0.0 Apr 7, 2022
@treee111 treee111 changed the title [FEATURE] X/Y coordinates can be given as input parameters + refactoring of GUI & CLI processing [FEATURE] X/Y coordinates can be given as input parameters (e.g. for testing!) & refactoring of GUI & CLI processing Apr 7, 2022
@treee111 treee111 merged commit b9b5eea into develop Apr 7, 2022
@treee111 treee111 deleted the new-input-processing branch April 7, 2022 17:58
@treee111 treee111 mentioned this pull request Apr 7, 2022
5 tasks
treee111 added a commit that referenced this pull request Apr 8, 2022
…testing!) & refactoring of GUI & CLI processing (#99)

This PR makes it possible to provide X/Y coordinates via command line as input parameter to create the corresponding map

* change start of the tool via two parsers

- to distinct between GUI and CLI processing clearer
- to be able to implement input of X/Y coordinates in the future

* refactor input processing

* adjust input processing (differentiate input further)

- incl. adjusting relevat unit tests

* implement input as X/Y coordinates

- functions to provide the functionality
- call of them

* different changes

- tests
- country-name without "/" for X/Y coordinates

* update documentation and launch config

* PR review findings

* implement multiple x/y combinations as input parameters

- in coding & tests
- launch config: malta as x/y + multiple x/y comb

* update documentation for CLI usage in USAGE.md

* do not log each .json file

BREAKING CHANGE:
The GUI and CLI of wahooMapsCreator will now be called differently than
before:
- `python wahoo_map_creator.py gui` and
- `python wahoo_map_creator.py cli -co malta`
This will ensure better control over the CLI input parameters, help
messages and is more consistent now!
treee111 added a commit that referenced this pull request Apr 8, 2022
…testing!) & refactoring of GUI & CLI processing (#99)

This PR makes it possible to provide X/Y coordinates via command line as input parameter to create the corresponding map

* change start of the tool via two parsers

- to distinct between GUI and CLI processing clearer
- to be able to implement input of X/Y coordinates in the future

* refactor input processing

* adjust input processing (differentiate input further)

- incl. adjusting relevat unit tests

* implement input as X/Y coordinates

- functions to provide the functionality
- call of them

* different changes

- tests
- country-name without "/" for X/Y coordinates

* update documentation and launch config

* PR review findings

* implement multiple x/y combinations as input parameters

- in coding & tests
- launch config: malta as x/y + multiple x/y comb

* update documentation for CLI usage in USAGE.md

* do not log each .json file

BREAKING CHANGE:
The GUI and CLI of wahooMapsCreator will now be called differently than
before:
- `python wahoo_map_creator.py gui` and
- `python wahoo_map_creator.py cli -co malta`

This will ensure better control over the CLI input parameters, help
messages and is more consistent now!
treee111 added a commit that referenced this pull request Apr 9, 2022
… testing!) & refactoring of GUI & CLI processing (#99)

This PR makes it possible to provide X/Y coordinates via command line as input parameter to create the corresponding map

* change start of the tool via two parsers

- to distinct between GUI and CLI processing clearer
- to be able to implement input of X/Y coordinates in the future

* refactor input processing

* adjust input processing (differentiate input further)

- incl. adjusting relevat unit tests

* implement input as X/Y coordinates

- functions to provide the functionality
- call of them

* different changes

- tests
- country-name without "/" for X/Y coordinates

* update documentation and launch config

* PR review findings

* implement multiple x/y combinations as input parameters

- in coding & tests
- launch config: malta as x/y + multiple x/y comb

* update documentation for CLI usage in USAGE.md

* do not log each .json file

BREAKING CHANGE:
The GUI and CLI of wahooMapsCreator will now be called differently than
before:
- `python wahoo_map_creator.py gui` and
- `python wahoo_map_creator.py cli -co malta`

This will ensure better control over the CLI input parameters, help
messages and is more consistent now!
@treee111 treee111 changed the title [FEATURE] X/Y coordinates can be given as input parameters (e.g. for testing!) & refactoring of GUI & CLI processing [BREAKING] X/Y coordinates can be given as input parameters (e.g. for testing!) & refactoring of GUI & CLI processing Apr 9, 2022
treee111 added a commit that referenced this pull request Apr 11, 2022
…on-file with tile(s). It is replaced by #99 (#105)

* remove primary input option "-fi" json-file with tile

- remove the CLI input parameter across the repo
- adjust unittests accordingly
- delete the whole /tests/jsons folder

* tidy up launch config

- remove -fi entries for .json files
- delete unused entries
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.

1 participant