Add sparse checkout support - #319

Coverage Report for CI Build 34588732812

Coverage increased (+0.6%) to 83.905%

Details

• Coverage increased (+0.6%) from the base build.
• Patch coverage: 6 uncovered changes across 1 file (225 of 231 lines covered, 97.4%).
• No coverage regressions found.

Uncovered Changes

Coverage Regressions

No coverage regressions found.

Coverage Stats

Relevant Lines:	5946
Covered Lines:	4989
Line Coverage:	83.91%
Coverage Strength:	0.84 hits per line

💛 - Coveralls

@varmar05 Kind of late review:

It is worth adding a line in the Readme example: https://github.com/MerginMaps/python-api-client/blob/master/README.md?plain=1#L101

How does the filter actually work with nested folders?
-- include *.gpkg includes all gpkgs anywhere in the project directory?
-- exclude media/* excludes only files in the media folder, but not media/photos/ folder?
Not sure if this is consistent. It would be nice to add a paragraph in the docs

Did you think about conflicted copies? --include base.gpkg won't sync its conflicted copies - which is probably ok. But --include *.qgs ignores project file's conflicts as we add ~ to the extension (https://github.com/MerginMaps/python-api-client/blob/master/mergin/utils.py#L186). It needs proper documentation rather than fixing.

How about making the filter json compatible for future enhancements? https://github.com/MerginMaps/python-api-client/blob/sparse_checkout/mergin/merginproject.py#L219 raises an error if there is a new key added. Reading the two keys would allow us to add more filters. instead return json.load(f), something like data = json.load(f); return {"include": data.get("include"), "exclude": data.get("exclude")}

From the support view I think we should log the filters applied before we list the sync changes.