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

Make video download optional for sample datasets #224

Open niksirbi opened 2 weeks ago

niksirbi commented 2 weeks ago

Description

What is this PR

Why is this PR needed? See issue 181.

What does this PR do? It introduces a with_video argument to sample_data.fetch_dataset and sample_data.fetch_dataset_paths. The default is False, which is sensible I think because videos can be large and we don't want to get them unless we are sure we want them. This should speedup CI somewhat, and also the execution of examples in binder.

There is only one test (so far) for which a video is necessary, the one that tests the video-fetching functionality itself. For that test we now use the smallest available video (~5MB).

The "Sample Data" section of docs has been updated accordingly.

References

Closes #181

How has this PR been tested?

Updated existing test with parametrisation across the new with_video argument.

Is this a breaking change?

Noe.

Does this PR require an update to the documentation?

Yes, done.

Checklist:

sonarcloud[bot] commented 2 weeks 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

codecov[bot] commented 2 weeks ago

Codecov Report

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

Project coverage is 99.70%. Comparing base (ba10263) to head (bbd97ab).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #224 +/- ## ======================================= Coverage 99.70% 99.70% ======================================= Files 12 12 Lines 678 678 ======================================= Hits 676 676 Misses 2 2 ```

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