Release commit created with Cranko.

+++ cranko-release-info-v1 [[projects]] qnames = ["wwt_api_client", "pypa"] version = "0.6.0" age = 0 +++
WorldWideTelescope · Dec 14, 2023 · 562d169 · 562d169
2 parents 0e088d0 + fe61ba3
commit 562d169
Show file tree

Hide file tree

Showing 35 changed files with 373 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+# wwt_api_client 0.6.0 (2023-12-14)
+
+- Document and expose various new data in the backend API, including
+  metrics (#29, @pkgw) and scene content (#30, @Carifio24).
+- Support the new `published` flag associated with scenes (#30, @Carifio24).
+  This may be a breaking change for some uses of the data structures.
+
+
 # wwt_api_client 0.5.0 (2023-10-24)
 
 Start defaulting to the production Constellations API service (#28, @pkgw)!

diff --git a/docs/api/wwt_api_client.constellations.data.HandleImageStats.rst b/docs/api/wwt_api_client.constellations.data.HandleImageStats.rst
@@ -6,6 +6,12 @@ HandleImageStats
 .. autoclass:: HandleImageStats
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~HandleImageStats.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ HandleImageStats
       ~HandleImageStats.to_dict
       ~HandleImageStats.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.HandleInfo.rst b/docs/api/wwt_api_client.constellations.data.HandleInfo.rst
@@ -6,6 +6,12 @@ HandleInfo
 .. autoclass:: HandleInfo
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~HandleInfo.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ HandleInfo
       ~HandleInfo.to_dict
       ~HandleInfo.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.HandlePermissions.rst b/docs/api/wwt_api_client.constellations.data.HandlePermissions.rst
@@ -6,6 +6,12 @@ HandlePermissions
 .. autoclass:: HandlePermissions
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~HandlePermissions.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ HandlePermissions
       ~HandlePermissions.to_dict
       ~HandlePermissions.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.HandleSceneStats.rst b/docs/api/wwt_api_client.constellations.data.HandleSceneStats.rst
@@ -6,6 +6,12 @@ HandleSceneStats
 .. autoclass:: HandleSceneStats
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~HandleSceneStats.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ HandleSceneStats
       ~HandleSceneStats.to_dict
       ~HandleSceneStats.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.HandleStats.rst b/docs/api/wwt_api_client.constellations.data.HandleStats.rst
@@ -6,6 +6,12 @@ HandleStats
 .. autoclass:: HandleStats
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~HandleStats.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ HandleStats
       ~HandleStats.to_dict
       ~HandleStats.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.HandleUpdate.rst b/docs/api/wwt_api_client.constellations.data.HandleUpdate.rst
@@ -6,6 +6,13 @@ HandleUpdate
 .. autoclass:: HandleUpdate
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~HandleUpdate.dataclass_json_config
+      ~HandleUpdate.display_name
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +23,11 @@ HandleUpdate
       ~HandleUpdate.to_dict
       ~HandleUpdate.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+   .. autoattribute:: display_name
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageApiPermissions.rst b/docs/api/wwt_api_client.constellations.data.ImageApiPermissions.rst
@@ -6,6 +6,12 @@ ImageApiPermissions
 .. autoclass:: ImageApiPermissions
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageApiPermissions.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ ImageApiPermissions
       ~ImageApiPermissions.to_dict
       ~ImageApiPermissions.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageContentPermissions.rst b/docs/api/wwt_api_client.constellations.data.ImageContentPermissions.rst
@@ -6,6 +6,13 @@ ImageContentPermissions
 .. autoclass:: ImageContentPermissions
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageContentPermissions.credits
+      ~ImageContentPermissions.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +23,11 @@ ImageContentPermissions
       ~ImageContentPermissions.to_dict
       ~ImageContentPermissions.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: credits
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageDisplayInfo.rst b/docs/api/wwt_api_client.constellations.data.ImageDisplayInfo.rst
@@ -6,6 +6,12 @@ ImageDisplayInfo
 .. autoclass:: ImageDisplayInfo
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageDisplayInfo.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ ImageDisplayInfo
       ~ImageDisplayInfo.to_dict
       ~ImageDisplayInfo.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageInfo.rst b/docs/api/wwt_api_client.constellations.data.ImageInfo.rst
@@ -6,6 +6,12 @@ ImageInfo
 .. autoclass:: ImageInfo
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageInfo.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ ImageInfo
       ~ImageInfo.to_dict
       ~ImageInfo.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageStorage.rst b/docs/api/wwt_api_client.constellations.data.ImageStorage.rst
@@ -6,6 +6,13 @@ ImageStorage
 .. autoclass:: ImageStorage
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageStorage.dataclass_json_config
+      ~ImageStorage.legacy_url_template
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +23,11 @@ ImageStorage
       ~ImageStorage.to_dict
       ~ImageStorage.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+   .. autoattribute:: legacy_url_template
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageSummary.rst b/docs/api/wwt_api_client.constellations.data.ImageSummary.rst
@@ -6,6 +6,12 @@ ImageSummary
 .. autoclass:: ImageSummary
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageSummary.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ ImageSummary
       ~ImageSummary.to_dict
       ~ImageSummary.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageUpdate.rst b/docs/api/wwt_api_client.constellations.data.ImageUpdate.rst
@@ -6,6 +6,14 @@ ImageUpdate
 .. autoclass:: ImageUpdate
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageUpdate.dataclass_json_config
+      ~ImageUpdate.note
+      ~ImageUpdate.permissions
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +24,12 @@ ImageUpdate
       ~ImageUpdate.to_dict
       ~ImageUpdate.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+   .. autoattribute:: note
+   .. autoattribute:: permissions
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.ImageWwt.rst b/docs/api/wwt_api_client.constellations.data.ImageWwt.rst
@@ -6,6 +6,12 @@ ImageWwt
 .. autoclass:: ImageWwt
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ImageWwt.dataclass_json_config
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +22,10 @@ ImageWwt
       ~ImageWwt.to_dict
       ~ImageWwt.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict

diff --git a/docs/api/wwt_api_client.constellations.data.SceneContent.rst b/docs/api/wwt_api_client.constellations.data.SceneContent.rst
@@ -6,6 +6,13 @@ SceneContent
 .. autoclass:: SceneContent
    :show-inheritance:
 
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~SceneContent.dataclass_json_config
+      ~SceneContent.image_layers
+
    .. rubric:: Methods Summary
 
    .. autosummary::
@@ -16,6 +23,11 @@ SceneContent
       ~SceneContent.to_dict
       ~SceneContent.to_json
 
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: dataclass_json_config
+   .. autoattribute:: image_layers
+
    .. rubric:: Methods Documentation
 
    .. automethod:: from_dict