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.

Sign up for GitHub

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

Jump to bottom

chore!: harmonize CLI flags, rename CLI entry point and add tests for the CLI (DEV-2525) #463

Merged
merged 18 commits into from
Aug 14, 2023
Merged

chore!: harmonize CLI flags, rename CLI entry point and add tests for the CLI (DEV-2525) #463

merged 18 commits into from
Aug 14, 2023

Conversation

jnussbaum
Copy link
Collaborator

No description provided.

@jnussbaum jnussbaum self-assigned this Aug 9, 2023
@linear
Copy link

linear bot commented Aug 9, 2023 •
edited by jnussbaum
Loading

DEV-2525 rename CLI entry point and add tests for the CLI

The filename dsp_tools.py is not so helpful for someone who doesn't know that this is the CLI entry point. A name like cli_entry_point.py or command_line_entry_point.py would be more telling.

The e2e tests don't test the CLI. For this reason, bugs in dsp_tools.py are only detected when a user encounters a problem. Plus, some operations like accessing a non-python file from code may work in a developer-setting (with the repository as cwd), but they fail when a user executes the command from the CLI, with a cwd different from the source code distribution.

jnussbaum
jnussbaum commented Aug 10, 2023
View reviewed changes
test/e2e/test_tools.py Outdated Show resolved Hide resolved
jnussbaum
jnussbaum commented Aug 10, 2023
View reviewed changes
src/dsp_tools/excel2xml.py Outdated Show resolved Hide resolved
BalduinLandolt
BalduinLandolt approved these changes Aug 14, 2023
View reviewed changes
Copy link
Collaborator

@BalduinLandolt BalduinLandolt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comments - but over all looking good

src/dsp_tools/cli_entry_point.py Outdated Show resolved Hide resolved
src/dsp_tools/utils/id_to_iri.py Show resolved Hide resolved
src/dsp_tools/cli_entry_point.py Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@jnussbaum jnussbaum changed the title chore: rename CLI entry point and add tests for the CLI (DEV-2525) chore!: rename CLI entry point and add tests for the CLI (DEV-2525) Aug 14, 2023
@jnussbaum jnussbaum changed the title chore!: rename CLI entry point and add tests for the CLI (DEV-2525) chore!: harmonize CLI flags, rename CLI entry point and add tests for the CLI (DEV-2525) Aug 14, 2023
@jnussbaum jnussbaum merged commit c1218d6 into main Aug 14, 2023
4 checks passed
@jnussbaum jnussbaum deleted the wip/dev-2525-rename-dsp_tools.py branch August 14, 2023 15:03
@daschbot daschbot mentioned this pull request Aug 14, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BalduinLandolt BalduinLandolt BalduinLandolt approved these changes

Assignees

@jnussbaum jnussbaum

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jnussbaum @BalduinLandolt