feat: Optionally remove single-child top-level directory from extracted archives

[josephine-funken]

Description

Removes top-level directories from extracted files if its only child is a directory. This top-level directory in the archive is unnecessary and creates longer file paths than needed.

Fixes issue #401

Implemented changes

• [ ] Remove top-level directories by default in Dataset.extract(), dataset_download.extract_dataset() and utils.archives.extract_archive().

Type of change

• [ ] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

• [ ] tests/utils/archives_test.test_extract_archive_destination_path_None()
• [ ] test_extract_archive_destination_path_not_None()

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [x] Any dependent changes have been merged and published in downstream modules
• [x] I have checked my code and corrected any misspellings

[SiQube]

@josephine-funken thank you for this great work! there seems to be a merge conflict which needs to be removed first -- if you have any questions how to resolve it feel free to reach out.

[codecov[bot]]

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (417a305) 100.00% compared to head (3118012) 100.00%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #579 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 52 52 Lines 2337 2348 +11 Branches 582 587 +5 ========================================= + Hits 2337 2348 +11 ``` | [Files](https://app.codecov.io/gh/aeye-lab/pymovements/pull/579?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab) | Coverage Δ | | |---|---|---| | [src/pymovements/dataset/dataset.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/579?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2RhdGFzZXQvZGF0YXNldC5weQ==) | `100.00% <100.00%> (ø)` | | | [src/pymovements/dataset/dataset\_download.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/579?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2RhdGFzZXQvZGF0YXNldF9kb3dubG9hZC5weQ==) | `100.00% <ø> (ø)` | | | [src/pymovements/utils/archives.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/579?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL3V0aWxzL2FyY2hpdmVzLnB5) | `100.00% <100.00%> (ø)` | | | [src/pymovements/utils/downloads.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/579?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL3V0aWxzL2Rvd25sb2Fkcy5weQ==) | `100.00% <ø> (ø)` | |

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

[josephine-funken]

Added functionality to remove top-level directories to downloads.download_and_extract_archive() and added parameter to corresponding test.