Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project/Dataset export import API alignment #446

Merged
merged 14 commits into from
Jul 1, 2024

Conversation

igor-davidyuk
Copy link
Contributor

Introduce methods for importing and exporting project and dataset snapshots following the web UI functionality.

Signed-off-by: Igor Davidyuk <[email protected]>
Copy link
Collaborator

@ljcornel ljcornel left a comment

Choose a reason for hiding this comment

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

Great work, thanks a lot!

Aside from a couple of minor remarks, one thing I'm still missing is the documentation for the new methods. I'm not sure what the best place to add this is, but I'd like to see a short list of the methods we have now for up/download, along with a short description. I think having an overview like that somewhere would help users to select the method appropriate for their use case.

Maybe we can add it to the import/export module init? That way it should be easy to include it in the sphinx documentation as well.

geti_sdk/import_export/tus_uploader.py Outdated Show resolved Hide resolved
geti_sdk/data_models/enums/dataset_format.py Outdated Show resolved Hide resolved
geti_sdk/import_export/import_export_module.py Outdated Show resolved Hide resolved
notebooks/009_download_and_upload_project.ipynb Outdated Show resolved Hide resolved
igor-davidyuk and others added 3 commits June 25, 2024 16:32
Signed-off-by: Igor Davidyuk <[email protected]>
Signed-off-by: Igor Davidyuk <[email protected]>
@igor-davidyuk
Copy link
Contributor Author

Maybe we can add it to the import/export module init? That way it should be easy to include it in the sphinx documentation as well.

The IE module does not expose these methods. Instead, I added the description for all the methods to the Geti module docstring.

Signed-off-by: Igor Davidyuk <[email protected]>
@ljcornel ljcornel merged commit 2309d8f into main Jul 1, 2024
11 checks passed
@ljcornel ljcornel deleted the idavidyu/CVS-100811-export-import-api-alignment branch July 1, 2024 09:10
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.

2 participants