supervisely 6.73.362__py3-none-any.whl → 6.73.363__py3-none-any.whl

supervisely/project/project.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import asyncio
 import io
+import json
 import os
 import pickle
 import random
@@ -4465,7 +4466,7 @@ def _download_project(
         try:
             if download_blob_files:
                 project_info = api.project.get_info_by_id(project_id)
-                create_blob_readme(project_fs=project_fs, project_info=project_info)
+                create_blob_readme(project_fs=project_fs, project_info=project_info, api=api)
             else:
                 create_readme(dest_dir, project_id, api)
         except Exception as e:
@@ -5092,6 +5093,10 @@ def create_readme(
         "{{dataset_structure_info}}", _dataset_structure_md(project_info, api)
     )
 
+    template = template.replace(
+        "{{dataset_description_info}}", _dataset_descriptions_md(project_info, api)
+    )
+
     with open(readme_path, "w") as f:
         f.write(template)
     return readme_path
@@ -5256,6 +5261,7 @@ def _dataset_blob_structure_md(
 def create_blob_readme(
     project_fs: Project,
     project_info: ProjectInfo,
+    api: Api,
 ) -> str:
     """Creates a README.md file using the template, adds general information
     about the project and creates a dataset structure section.
@@ -5294,7 +5300,9 @@ def create_blob_readme(
     template = template.replace(
         "{{dataset_structure_info}}", _dataset_blob_structure_md(project_fs, project_info)
     )
-
+    template = template.replace(
+        "{{dataset_description_info}}", _dataset_descriptions_md(project_info, api)
+    )
     with open(readme_path, "w") as f:
         f.write(template)
     return readme_path
@@ -5430,6 +5438,37 @@ def _dataset_structure_md(
 
     return "".join(result_md)
 
+def _dataset_descriptions_md(project_info: sly.ProjectInfo, api: sly.Api) -> str:
+    """Creates a markdown string with dictionary of descriptions and custom data of datasets.
+    :param project_info: Project information.
+    :type project_info: :class:`ProjectInfo<supervisely.project.project_info.ProjectInfo>`
+    :param api: Supervisely API address and token.
+    :type api: :class:`Api<supervisely.api.api.Api>`
+    :return: Markdown string with dictionary of descriptions and custom data of datasets.
+    :rtype: str
+    """
+
+    data_found = False
+    result_md = "All datasets in the project can have their own descriptions and custom data. You can add or edit the description and custom data of a dataset in the datasets list page. In this section, you can find this information for each dataset by dataset name (e.g. `ds1/ds2/ds3`, where `ds1` and `ds2` are parent datasets for `ds3` dataset).<br>"
+    result_md += "\n\n```json\n{\n"
+    for parents, dataset_info in api.dataset.tree(project_info.id):
+        dataset_info = api.dataset.get_info_by_id(dataset_info.id)
+        full_ds_name = "/".join(parents + [dataset_info.name])
+        if dataset_info.description or dataset_info.custom_data:
+            data_found = True
+            result_md += f"  \"{full_ds_name}\": {{\n"
+            if dataset_info.description:
+                result_md += f"    \"description\": \"{dataset_info.description}\",\n"
+            if dataset_info.custom_data:
+                formated_custom_data = json.dumps(dataset_info.custom_data, indent=4)
+                formated_custom_data = formated_custom_data.replace("\n", "\n    ")
+                result_md += f"    \"custom_data\": {formated_custom_data}\n"
+            result_md += "  },\n"
+    result_md += "}\n```"
+    if not data_found:
+        result_md = "_No dataset descriptions or custom data found in the project._"
+    return result_md
+
 
 async def _download_project_async(
     api: sly.Api,
@@ -5697,7 +5736,7 @@ async def _download_project_async(
         try:
             if download_blob_files:
                 project_info = api.project.get_info_by_id(project_id)
-                create_blob_readme(project_fs=project_fs, project_info=project_info)
+                create_blob_readme(project_fs=project_fs, project_info=project_info, api=api)
             else:
                 create_readme(dest_dir, project_id, api)
         except Exception as e:

supervisely/project/readme_template.md

@@ -10,6 +10,10 @@ This is a general information about the project.<br>
 In this section, you can find information about the dataset structure. Dataset names are clickable and will redirect you to the corresponding folder.<br><br>
 {{dataset_structure_info}}<br>
 
+## Additional information (descriptions and custom data for datasets)
+
+{{dataset_description_info}}
+
 ## Useful links
 
 Please, visit the [Supervisely blog](https://supervisely.com/blog) to keep up with the latest news, updates, and tutorials and subscribe to [our YouTube channel](https://www.youtube.com/c/Supervisely) to watch video tutorials.<br>

{supervisely-6.73.362.dist-info → supervisely-6.73.363.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: supervisely
-Version: 6.73.362
+Version: 6.73.363
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely

{supervisely-6.73.362.dist-info → supervisely-6.73.363.dist-info}/RECORD

@@ -1035,11 +1035,11 @@ supervisely/project/data_version.py,sha256=P5Lui6i64pYeJWmAdGJDv8GRXxjfpSSZ8zT_M
 supervisely/project/download.py,sha256=nhxID-kbsNTgIY9l1lnRuUlzKrsJw80X07jEElyl3sE,28466
 supervisely/project/pointcloud_episode_project.py,sha256=yiWdNBQiI6f1O9sr1pg8JHW6O-w3XUB1rikJNn3Oung,41866
 supervisely/project/pointcloud_project.py,sha256=Kx1Vaes-krwG3BiRRtHRLQxb9G5m5bTHPN9IzRqmNWo,49399
-supervisely/project/project.py,sha256=k0eE6Jy9eDYO-WUbDK0a-IVA34VVWYRzMBVkPY9XdGw,235812
+supervisely/project/project.py,sha256=RokArUC17P7HXssoYXSKVCBo6DJvclwD-ozW7ysMWww,238002
 supervisely/project/project_meta.py,sha256=26s8IiHC5Pg8B1AQi6_CrsWteioJP2in00cRNe8QlW0,51423
 supervisely/project/project_settings.py,sha256=NLThzU_DCynOK6hkHhVdFyezwprn9UqlnrLDe_3qhkY,9347
 supervisely/project/project_type.py,sha256=7mQ7zg6r7Bm2oFn5aR8n_PeLqMmOaPZd6ph7Z8ZISTw,608
-supervisely/project/readme_template.md,sha256=NKYEoJubNWLV_HmhVmdB6L4dneLqDkvl2b71xy5fc54,9150
+supervisely/project/readme_template.md,sha256=VovSn591tcpz2xiwGgErm34iGHVxuGxXGPX6-iDiS88,9251
 supervisely/project/upload.py,sha256=AjgHYgVZwUE25ygC5pqvFjdAladbyB8T78mlet5Qpho,3750
 supervisely/project/video_project.py,sha256=zAtB3YpW9tC9Tc3qfapbQ9O2nhAWU2wDjMuS5sepXqc,65297
 supervisely/project/volume_project.py,sha256=Kn9VEvWuKKZvL2nx6B6bjSvHuoZhAOxEc6DvPRexUco,22666
@@ -1097,9 +1097,9 @@ supervisely/worker_proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 supervisely/worker_proto/worker_api_pb2.py,sha256=VQfi5JRBHs2pFCK1snec3JECgGnua3Xjqw_-b3aFxuM,59142
 supervisely/worker_proto/worker_api_pb2_grpc.py,sha256=3BwQXOaP9qpdi0Dt9EKG--Lm8KGN0C5AgmUfRv77_Jk,28940
 supervisely_lib/__init__.py,sha256=7-3QnN8Zf0wj8NCr2oJmqoQWMKKPKTECvjH9pd2S5vY,159
-supervisely-6.73.362.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-supervisely-6.73.362.dist-info/METADATA,sha256=pEJ1fz_ct_nNeRITHBz-wp16AYlUFbNvG9zwIKwbWTI,35151
-supervisely-6.73.362.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-supervisely-6.73.362.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
-supervisely-6.73.362.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
-supervisely-6.73.362.dist-info/RECORD,,
+supervisely-6.73.363.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+supervisely-6.73.363.dist-info/METADATA,sha256=6PAf_uEkpJWOi9CeWKDgUCmCGH7wEJeK7Gu41pIYqu8,35151
+supervisely-6.73.363.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+supervisely-6.73.363.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
+supervisely-6.73.363.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
+supervisely-6.73.363.dist-info/RECORD,,