Skip to content

Add prototype of new client #7

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

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
858 changes: 858 additions & 0 deletions client_demo.ipynb

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion nominal/_api/combined/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
'scout_chartdefinition_api',
'scout_checklistexecution_api',
'scout_checks_api',
'scout_comparisonnotebook_api',
'scout_comparisonrun_api',
'scout_compute_api',
'scout_compute_api_deprecated',
Expand Down Expand Up @@ -62,5 +63,5 @@

__conjure_generator_version__ = "4.9.0"

__version__ = "0.373.0+46.g8cf0464"
__version__ = "0.376.0+67.gc247f25.dirty"

2,554 changes: 2,283 additions & 271 deletions nominal/_api/combined/_impl.py

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion nominal/_api/combined/authentication_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
authentication_api_DefaultTimeRangeTypeSetting as DefaultTimeRangeTypeSetting,
authentication_api_OrgRid as OrgRid,
authentication_api_OrgSettings as OrgSettings,
authentication_api_OrgV2 as OrgV2,
authentication_api_SearchUsersResponse as SearchUsersResponse,
authentication_api_UpdateMyProfileRequest as UpdateMyProfileRequest,
authentication_api_UserRid as UserRid,
Expand Down
2 changes: 2 additions & 0 deletions nominal/_api/combined/datasource/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# coding=utf-8
from .._impl import (
datasource_DatasetFileId as DatasetFileId,
datasource_DatasetRid as DatasetRid,
datasource_Label as Label,
datasource_Property as Property,
datasource_PropertyName as PropertyName,
Expand Down
2 changes: 1 addition & 1 deletion nominal/_api/combined/scout_asset_api/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# coding=utf-8
from .._impl import (
scout_asset_api_AddDataScopesToAssetRequest as AddDataScopesToAssetRequest,
scout_asset_api_Asset as Asset,
scout_asset_api_AssetDataScope as AssetDataScope,
scout_asset_api_Channel as Channel,
Expand All @@ -18,7 +19,6 @@
scout_asset_api_SeriesTagValue as SeriesTagValue,
scout_asset_api_SortField as SortField,
scout_asset_api_SortOptions as SortOptions,
scout_asset_api_TimestampType as TimestampType,
scout_asset_api_Unit as Unit,
scout_asset_api_UpdateAssetRequest as UpdateAssetRequest,
scout_asset_api_UpdateAttachmentsRequest as UpdateAttachmentsRequest,
Expand Down
5 changes: 5 additions & 0 deletions nominal/_api/combined/scout_catalog/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from .._impl import (
scout_catalog_AbsoluteTimestamp as AbsoluteTimestamp,
scout_catalog_AbsoluteTimestampVisitor as AbsoluteTimestampVisitor,
scout_catalog_AddFileToDataset as AddFileToDataset,
scout_catalog_AllPropertiesAndLabelsResponse as AllPropertiesAndLabelsResponse,
scout_catalog_Bounds as Bounds,
scout_catalog_CatalogService as CatalogService,
Expand All @@ -11,6 +12,8 @@
scout_catalog_CreateDataset as CreateDataset,
scout_catalog_CustomTimestamp as CustomTimestamp,
scout_catalog_Dataset as Dataset,
scout_catalog_DatasetFile as DatasetFile,
scout_catalog_DatasetFilesPage as DatasetFilesPage,
scout_catalog_DatasetFilter as DatasetFilter,
scout_catalog_DatasetOriginMetadata as DatasetOriginMetadata,
scout_catalog_DeleteSeriesResult as DeleteSeriesResult,
Expand All @@ -35,6 +38,8 @@
scout_catalog_IngestStatusV2Visitor as IngestStatusV2Visitor,
scout_catalog_Iso8601Timestamp as Iso8601Timestamp,
scout_catalog_ListDatasetsRequest as ListDatasetsRequest,
scout_catalog_MarkFileIngestError as MarkFileIngestError,
scout_catalog_MarkFileIngestSuccessful as MarkFileIngestSuccessful,
scout_catalog_RelativeTimestamp as RelativeTimestamp,
scout_catalog_RetentionPolicy as RetentionPolicy,
scout_catalog_RetentionPolicyType as RetentionPolicyType,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# coding=utf-8
from .._impl import (
scout_channelvariables_api_ChannelVariable as ChannelVariable,
scout_channelvariables_api_ChannelVariableMap as ChannelVariableMap,
scout_channelvariables_api_ChannelVariableName as ChannelVariableName,
scout_channelvariables_api_ComputeSpec as ComputeSpec,
scout_channelvariables_api_ComputeSpecV1 as ComputeSpecV1,
scout_channelvariables_api_ComputeSpecVisitor as ComputeSpecVisitor,
scout_channelvariables_api_WorkbookChannelVariableMap as WorkbookChannelVariableMap,
)

Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
scout_chartdefinition_api_CartesianChartDefinitionVisitor as CartesianChartDefinitionVisitor,
scout_chartdefinition_api_CartesianPlot as CartesianPlot,
scout_chartdefinition_api_ChartDefinition as ChartDefinition,
scout_chartdefinition_api_ChartDefinitionMap as ChartDefinitionMap,
scout_chartdefinition_api_ChartDefinitionVisitor as ChartDefinitionVisitor,
scout_chartdefinition_api_ChecklistChartDefinition as ChecklistChartDefinition,
scout_chartdefinition_api_ChecklistChartDefinitionV1 as ChecklistChartDefinitionV1,
Expand Down Expand Up @@ -77,5 +76,6 @@
scout_chartdefinition_api_VideoChartDefinition as VideoChartDefinition,
scout_chartdefinition_api_VideoChartDefinitionV1 as VideoChartDefinitionV1,
scout_chartdefinition_api_VideoChartDefinitionVisitor as VideoChartDefinitionVisitor,
scout_chartdefinition_api_WorkbookChartDefinitionMap as WorkbookChartDefinitionMap,
)

Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
scout_checklistexecution_api_ComputationRange as ComputationRange,
scout_checklistexecution_api_ComputedResult as ComputedResult,
scout_checklistexecution_api_Computing as Computing,
scout_checklistexecution_api_ExecuteChecklistForAssetsRequest as ExecuteChecklistForAssetsRequest,
scout_checklistexecution_api_ExecuteChecklistForAssetsResponse as ExecuteChecklistForAssetsResponse,
scout_checklistexecution_api_Fail as Fail,
scout_checklistexecution_api_FailedToResolve as FailedToResolve,
scout_checklistexecution_api_Failure as Failure,
Expand Down
31 changes: 31 additions & 0 deletions nominal/_api/combined/scout_comparisonnotebook_api/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# coding=utf-8
from .._impl import (
scout_comparisonnotebook_api_AggregationType as AggregationType,
scout_comparisonnotebook_api_AggregationTypeVisitor as AggregationTypeVisitor,
scout_comparisonnotebook_api_ChannelVariable as ChannelVariable,
scout_comparisonnotebook_api_ChartDefinition as ChartDefinition,
scout_comparisonnotebook_api_ChartDefinitionVisitor as ChartDefinitionVisitor,
scout_comparisonnotebook_api_ComparisonChannelVariableMap as ComparisonChannelVariableMap,
scout_comparisonnotebook_api_ComparisonChartDefinitionMap as ComparisonChartDefinitionMap,
scout_comparisonnotebook_api_ComparisonTableColumn as ComparisonTableColumn,
scout_comparisonnotebook_api_ComparisonTableColumnOptions as ComparisonTableColumnOptions,
scout_comparisonnotebook_api_ComparisonTableColumnVisualizationOptions as ComparisonTableColumnVisualizationOptions,
scout_comparisonnotebook_api_ComparisonTableDefinition as ComparisonTableDefinition,
scout_comparisonnotebook_api_ComparisonTableDefinitionV1 as ComparisonTableDefinitionV1,
scout_comparisonnotebook_api_ComparisonTableDefinitionVisitor as ComparisonTableDefinitionVisitor,
scout_comparisonnotebook_api_ComparisonTableVisualizationOptions as ComparisonTableVisualizationOptions,
scout_comparisonnotebook_api_ComparisonWorkbookContent as ComparisonWorkbookContent,
scout_comparisonnotebook_api_ComparisonWorkbookContext as ComparisonWorkbookContext,
scout_comparisonnotebook_api_ContextProvider as ContextProvider,
scout_comparisonnotebook_api_ContextProviderVisitor as ContextProviderVisitor,
scout_comparisonnotebook_api_Max as Max,
scout_comparisonnotebook_api_Mean as Mean,
scout_comparisonnotebook_api_Min as Min,
scout_comparisonnotebook_api_RangeAggregationContext as RangeAggregationContext,
scout_comparisonnotebook_api_RangeAggregationDataScope as RangeAggregationDataScope,
scout_comparisonnotebook_api_RangeAggregationDataScopeVisitor as RangeAggregationDataScopeVisitor,
scout_comparisonnotebook_api_StandardDeviation as StandardDeviation,
scout_comparisonnotebook_api_VariableLocator as VariableLocator,
scout_comparisonnotebook_api_VariableName as VariableName,
)

17 changes: 17 additions & 0 deletions nominal/_api/combined/scout_compute_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
scout_compute_api_ComputeService as ComputeService,
scout_compute_api_ComputeUnitResult as ComputeUnitResult,
scout_compute_api_ComputeUnitResultVisitor as ComputeUnitResultVisitor,
scout_compute_api_ComputeUnitsRequest as ComputeUnitsRequest,
scout_compute_api_Context as Context,
scout_compute_api_Count as Count,
scout_compute_api_CumulativeSumSeriesNode as CumulativeSumSeriesNode,
Expand All @@ -46,6 +47,7 @@
scout_compute_api_DoubleConstantVisitor as DoubleConstantVisitor,
scout_compute_api_DurationConstant as DurationConstant,
scout_compute_api_DurationConstantVisitor as DurationConstantVisitor,
scout_compute_api_Empty as Empty,
scout_compute_api_EnumAggregationFunction as EnumAggregationFunction,
scout_compute_api_EnumBucket as EnumBucket,
scout_compute_api_EnumFilterOperator as EnumFilterOperator,
Expand All @@ -66,6 +68,9 @@
scout_compute_api_EnumUnionOperation as EnumUnionOperation,
scout_compute_api_EnumUnionSeriesNode as EnumUnionSeriesNode,
scout_compute_api_EqualityOperator as EqualityOperator,
scout_compute_api_ErrorCode as ErrorCode,
scout_compute_api_ErrorResult as ErrorResult,
scout_compute_api_ErrorType as ErrorType,
scout_compute_api_ExcludeNegativeValues as ExcludeNegativeValues,
scout_compute_api_ExponentialAverage as ExponentialAverage,
scout_compute_api_FftNode as FftNode,
Expand Down Expand Up @@ -136,15 +141,27 @@
scout_compute_api_OnChangeRangesNode as OnChangeRangesNode,
scout_compute_api_OutputRangeStart as OutputRangeStart,
scout_compute_api_OutputRangeStartVisitor as OutputRangeStartVisitor,
scout_compute_api_ParameterInput as ParameterInput,
scout_compute_api_ParameterizedComputeNodeRequest as ParameterizedComputeNodeRequest,
scout_compute_api_ParameterizedComputeNodeResponse as ParameterizedComputeNodeResponse,
scout_compute_api_ParameterizedComputeNodeResult as ParameterizedComputeNodeResult,
scout_compute_api_ParameterizedComputeNodeResultVisitor as ParameterizedComputeNodeResultVisitor,
scout_compute_api_ParameterizedContext as ParameterizedContext,
scout_compute_api_PeakRangesNode as PeakRangesNode,
scout_compute_api_PeakType as PeakType,
scout_compute_api_PersistenceWindowConfiguration as PersistenceWindowConfiguration,
scout_compute_api_ProductSeriesNode as ProductSeriesNode,
scout_compute_api_Range as Range,
scout_compute_api_RangeAggregation as RangeAggregation,
scout_compute_api_RangeAggregationOperation as RangeAggregationOperation,
scout_compute_api_RangeAggregationOperationVisitor as RangeAggregationOperationVisitor,
scout_compute_api_RangeSummary as RangeSummary,
scout_compute_api_RangeValue as RangeValue,
scout_compute_api_RangeValueVisitor as RangeValueVisitor,
scout_compute_api_RangesFunction as RangesFunction,
scout_compute_api_RangesNode as RangesNode,
scout_compute_api_RangesNodeVisitor as RangesNodeVisitor,
scout_compute_api_RangesNumericAggregationNode as RangesNumericAggregationNode,
scout_compute_api_RangesSummary as RangesSummary,
scout_compute_api_RawEnumSeriesNode as RawEnumSeriesNode,
scout_compute_api_RawNumericSeriesNode as RawNumericSeriesNode,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
scout_compute_resolved_api_ProductSeriesNode as ProductSeriesNode,
scout_compute_resolved_api_RangesNode as RangesNode,
scout_compute_resolved_api_RangesNodeVisitor as RangesNodeVisitor,
scout_compute_resolved_api_RangesNumericAggregationNode as RangesNumericAggregationNode,
scout_compute_resolved_api_RawEnumSeriesNode as RawEnumSeriesNode,
scout_compute_resolved_api_RawNumericSeriesNode as RawNumericSeriesNode,
scout_compute_resolved_api_RawUntypedSeriesNode as RawUntypedSeriesNode,
Expand Down
3 changes: 3 additions & 0 deletions nominal/_api/combined/scout_notebook_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
scout_notebook_api_GetAllLabelsAndPropertiesResponse as GetAllLabelsAndPropertiesResponse,
scout_notebook_api_Lock as Lock,
scout_notebook_api_Notebook as Notebook,
scout_notebook_api_NotebookDataScope as NotebookDataScope,
scout_notebook_api_NotebookDataScopeVisitor as NotebookDataScopeVisitor,
scout_notebook_api_NotebookMetadata as NotebookMetadata,
scout_notebook_api_NotebookMetadataWithRid as NotebookMetadataWithRid,
scout_notebook_api_NotebookType as NotebookType,
scout_notebook_api_SearchNotebooksQuery as SearchNotebooksQuery,
scout_notebook_api_SearchNotebooksQueryVisitor as SearchNotebooksQueryVisitor,
scout_notebook_api_SearchNotebooksRequest as SearchNotebooksRequest,
Expand Down
2 changes: 2 additions & 0 deletions nominal/_api/combined/scout_workbookcommon_api/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# coding=utf-8
from .._impl import (
scout_workbookcommon_api_UnifiedWorkbookContent as UnifiedWorkbookContent,
scout_workbookcommon_api_UnifiedWorkbookContentVisitor as UnifiedWorkbookContentVisitor,
scout_workbookcommon_api_WorkbookContent as WorkbookContent,
)

69 changes: 69 additions & 0 deletions nominal/_workbook.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# not yet working - leaving here for reference

import keyring as kr
from _api.scout import NotebookService
from ._utils import create_service
from .cloud import get_base_url

from _api.scout_notebook_api import CreateNotebookRequest, ChartWithOverlays
from _api.scout_layout_api import WorkbookLayout, WorkbookLayoutV1, Panel, ChartPanel, ChartPanelV1
from _api.scout_workbookcommon_api import WorkbookContent
from _api.scout_rids_api import Version, VersionedChartRid

from _api.scout_chartdefinition_api import (
ChartDefinition,
ChartDefinitionMap,
TimeSeriesChartDefinition,
TimeSeriesChartDefinitionV1,
TimeSeriesRow,
)

from uuid import uuid4

TOKEN = kr.get_password("Nominal API", "python-client")
notebook = create_service(NotebookService, get_base_url())

chart_rid = "ri.chart.hmm." + str(uuid4())
version = Version(1)

notebook.create(
TOKEN,
CreateNotebookRequest(
title="alx notebook",
description="",
is_draft=False,
state_as_json="{}",
charts=[ChartWithOverlays(rid=chart_rid, version=version, overlays="{}")],
run_rid="ri.scout.gov-staging.run.e326f85b-c517-4605-8241-e850541238a2",
layout=WorkbookLayout(
v1=WorkbookLayoutV1(
root_panel=Panel(
chart=ChartPanel(
v1=ChartPanelV1(
id=str(uuid4()),
chart_rid=VersionedChartRid(rid=chart_rid, version=version),
hide_legend=True,
)
)
)
)
),
content=WorkbookContent(
channel_variables={
"var_name": ComputeSpec() # serialized json of the FE api
},
charts={
chart_rid: ChartDefinition(
time_series=TimeSeriesChartDefinition(
v1=TimeSeriesChartDefinitionV1(
rows=[TimeSeriesRow(plots=[], row_flex_size=1.0)],
comparison_run_groups=[],
events=[],
value_axes=[],
)
)
)
},
),
),
)
Loading
Loading