Skip to content

Conversation

@lochhh
Copy link
Member

@lochhh lochhh commented May 13, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
This PR closes #168

What does this PR do?
This PR adds the CLI entrypoint that allows users to print diagnostic info in the CLI using movement info to, for instance, verify that movement was installed successfully. This PR also paves the way for adding other commands like movement label to launch the napari GUI.

References

#168

How has this PR been tested?

Tests have been added accordingly.

Does this PR require an update to the documentation?

Instructions to verify the movement installation have been added to the "Getting started" page.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@codecov
Copy link

codecov bot commented May 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.67%. Comparing base (c7c07a6) to head (836f092).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #176      +/-   ##
==========================================
+ Coverage   99.66%   99.67%   +0.01%     
==========================================
  Files          10       11       +1     
  Lines         591      610      +19     
==========================================
+ Hits          589      608      +19     
  Misses          2        2              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lochhh lochhh requested a review from niksirbi May 13, 2024 14:32
@lochhh lochhh marked this pull request as ready for review May 13, 2024 14:32
Copy link
Member

@niksirbi niksirbi left a comment

Choose a reason for hiding this comment

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

Love this! The only thing I'd add for now is "system" (as in Adam's mockup), if it's easy. Otherwise feel free to merge as is.

@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@lochhh
Copy link
Member Author

lochhh commented May 13, 2024

Love this! The only thing I'd add for now is "system" (as in Adam's mockup), if it's easy. Otherwise feel free to merge as is.

I tried System: {platform.system()} {platform.release()}" but the output contains what's already in platform.platform() - so I've reverted this again.

@lochhh lochhh added this pull request to the merge queue May 13, 2024
Merged via the queue into main with commit 7980688 May 13, 2024
@niksirbi niksirbi deleted the entrypoint branch May 13, 2024 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide a CLI entry point for movement info

3 participants