neuroinformatics-unit / movement

Python tools for analysing body movements across space and time
http://movement.neuroinformatics.dev
BSD 3-Clause "New" or "Revised" License
77 stars 7 forks source link

Add CLI entrypoint #176

Closed lochhh closed 1 month ago

lochhh commented 1 month ago

Description

What is this PR

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:

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sonarcloud[bot] commented 1 month ago

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 commented 1 month ago

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.