gofigr

GoFigr Client Library

• gofigr package
  • Module contents
    • ApiId
      • ApiId.api_id
    • AssetSync
      • AssetSync.clear_revisions()
      • AssetSync.open()
      • AssetSync.open_and_get_revision()
      • AssetSync.revisions
      • AssetSync.sync()
      • AssetSync.sync_revision()
    • FindByName
    • GoFigr
      • GoFigr.api_url
      • GoFigr.app_url
      • GoFigr.authenticate()
      • GoFigr.create_api_key()
      • GoFigr.find_analysis()
      • GoFigr.find_figure()
      • GoFigr.find_workspace()
      • GoFigr.get_api_key()
      • GoFigr.heartbeat()
      • GoFigr.jwt_url
      • GoFigr.list_api_keys()
      • GoFigr.open()
      • GoFigr.organizations
      • GoFigr.primary_workspace
      • GoFigr.revoke_api_key()
      • GoFigr.sync
      • GoFigr.update_user_info()
      • GoFigr.user_info()
      • GoFigr.workspaces
    • NotebookName
    • UserInfo
      • UserInfo.from_json()
      • UserInfo.to_json()
    • assert_one()
    • find_config()
    • load_ipython_extension()
  • Submodules
  • gofigr.jupyter module
    • JupyterPublisher
      • JupyterPublisher.auto_publish_hook()
      • JupyterPublisher.publish()
    • configure()
    • download_all()
    • download_file()
    • get_extension()
    • get_gofigr()
    • load_pickled_figure()
    • parse_uuid()
    • proxy_callback()
    • publish()
    • require_configured()
  • gofigr.models module
    • Base64Field
      • Base64Field.clone()
      • Base64Field.to_internal_value()
      • Base64Field.to_representation()
    • CodeLanguage
      • CodeLanguage.PYTHON
      • CodeLanguage.R
    • DataField
      • DataField.clone()
      • DataField.to_representation()
    • DataType
      • DataType.CODE
      • DataType.DATA_FRAME
      • DataType.FILE
      • DataType.IMAGE
      • DataType.TEXT
    • Field
      • Field.clone()
      • Field.to_internal_value()
      • Field.to_representation()
    • FlexibleStorageInfo
      • FlexibleStorageInfo.from_json()
      • FlexibleStorageInfo.to_json()
    • FlexibleStorageMixin
      • FlexibleStorageMixin.get_storage_info()
      • FlexibleStorageMixin.set_storage_info()
      • FlexibleStorageMixin.test_storage()
    • InvitationMixin
      • InvitationMixin.accept()
      • InvitationMixin.delete()
      • InvitationMixin.fetch()
      • InvitationMixin.fields
    • JSONField
      • JSONField.clone()
      • JSONField.to_internal_value()
      • JSONField.to_representation()
    • LinkSharingStatus
      • LinkSharingStatus.from_json()
      • LinkSharingStatus.to_json()
    • LinkedEntityCollection
      • LinkedEntityCollection.create()
      • LinkedEntityCollection.find()
      • LinkedEntityCollection.find_or_create()
    • LinkedEntityField
      • LinkedEntityField.clone()
      • LinkedEntityField.to_internal_value()
      • LinkedEntityField.to_representation()
    • LogItem
      • LogItem.fetch()
      • LogItem.from_json()
      • LogItem.to_json()
    • LogsMixin
      • LogsMixin.get_logs()
    • MembersMixin
      • MembersMixin.add_member()
      • MembersMixin.change_membership()
      • MembersMixin.get_members()
      • MembersMixin.remove_member()
    • MembershipInfo
      • MembershipInfo.from_json()
      • MembershipInfo.to_json()
    • MetadataProxyField
    • ModelMixin
      • ModelMixin.app_url
      • ModelMixin.client
      • ModelMixin.create()
      • ModelMixin.delete()
      • ModelMixin.endpoint
      • ModelMixin.fetch()
      • ModelMixin.fields
      • ModelMixin.from_json()
      • ModelMixin.include_if_none
      • ModelMixin.list()
      • ModelMixin.save()
      • ModelMixin.to_json()
    • NestedMixin
      • NestedMixin.from_json()
      • NestedMixin.to_json()
    • OrganizationMembership
      • OrganizationMembership.ALL_LEVELS
      • OrganizationMembership.ORG_ADMIN
      • OrganizationMembership.WORKSPACE_ADMIN
      • OrganizationMembership.WORKSPACE_CREATOR
      • OrganizationMembership.WORKSPACE_VIEWER
    • Recents
      • Recents.analyses
      • Recents.assets
      • Recents.figures
    • RevisionMixin
      • RevisionMixin.create()
      • RevisionMixin.fetch()
      • RevisionMixin.fetch_data()
      • RevisionMixin.save()
    • ShareableModelMixin
      • ShareableModelMixin.get_link_sharing()
      • ShareableModelMixin.get_sharing_users()
      • ShareableModelMixin.set_link_sharing()
      • ShareableModelMixin.share()
      • ShareableModelMixin.unshare()
    • SharingUserData
      • SharingUserData.from_json()
      • SharingUserData.to_json()
    • ThumbnailMixin
      • ThumbnailMixin.get_thumbnail()
    • Timestamp
      • Timestamp.clone()
      • Timestamp.to_internal_value()
      • Timestamp.to_representation()
    • WorkspaceMembership
      • WorkspaceMembership.ADMIN
      • WorkspaceMembership.ALL_LEVELS
      • WorkspaceMembership.CREATOR
      • WorkspaceMembership.OWNER
      • WorkspaceMembership.VIEWER
    • WorkspaceType
      • WorkspaceType.PRIMARY
      • WorkspaceType.SECONDARY
    • gf_Analysis
      • gf_Analysis.endpoint
      • gf_Analysis.fields
      • gf_Analysis.get_figure()
    • gf_ApiKey
      • gf_ApiKey.endpoint
      • gf_ApiKey.fetch_and_preserve_token()
      • gf_ApiKey.fields
    • gf_Asset
      • gf_Asset.endpoint
      • gf_Asset.fields
      • gf_Asset.find_by_name()
    • gf_AssetLinkedToFigure
      • gf_AssetLinkedToFigure.endpoint
      • gf_AssetLinkedToFigure.fields
    • gf_AssetRevision
      • gf_AssetRevision.endpoint
      • gf_AssetRevision.fields
      • gf_AssetRevision.find_by_hash()
    • gf_CodeData
      • gf_CodeData.DATA_TYPE
      • gf_CodeData.contents
      • gf_CodeData.encoding
      • gf_CodeData.format
      • gf_CodeData.language
      • gf_CodeData.metadata_fields
    • gf_Data
      • gf_Data.DATA_TYPE
      • gf_Data.SPECIALIZED_TYPES
      • gf_Data.calculate_hash()
      • gf_Data.endpoint
      • gf_Data.fields
      • gf_Data.get_storage_info()
      • gf_Data.is_shallow
      • gf_Data.local_id
      • gf_Data.metadata_fields
      • gf_Data.specialize()
    • gf_Figure
      • gf_Figure.endpoint
      • gf_Figure.fields
    • gf_FileData
      • gf_FileData.DATA_TYPE
      • gf_FileData.metadata_fields
      • gf_FileData.path
      • gf_FileData.read()
      • gf_FileData.write()
    • gf_ImageData
      • gf_ImageData.DATA_TYPE
      • gf_ImageData.format
      • gf_ImageData.image
      • gf_ImageData.is_interactive
      • gf_ImageData.is_watermarked
      • gf_ImageData.metadata_fields
    • gf_MetadataProxy
      • gf_MetadataProxy.delete()
      • gf_MetadataProxy.endpoint
      • gf_MetadataProxy.fetch()
      • gf_MetadataProxy.fields
      • gf_MetadataProxy.save()
      • gf_MetadataProxy.update_metadata()
    • gf_Organization
      • gf_Organization.endpoint
      • gf_Organization.fields
      • gf_Organization.get_invitations()
    • gf_OrganizationInvitation
      • gf_OrganizationInvitation.endpoint
      • gf_OrganizationInvitation.fields
    • gf_Revision
      • gf_Revision.code_data
      • gf_Revision.endpoint
      • gf_Revision.fields
      • gf_Revision.file_data
      • gf_Revision.image_data
      • gf_Revision.revision_url
      • gf_Revision.table_data
      • gf_Revision.text_data
    • gf_TableData
      • gf_TableData.DATA_TYPE
      • gf_TableData.dataframe
      • gf_TableData.encoding
      • gf_TableData.format
      • gf_TableData.metadata_fields
    • gf_TextData
      • gf_TextData.DATA_TYPE
      • gf_TextData.contents
      • gf_TextData.encoding
      • gf_TextData.metadata_fields
    • gf_Workspace
      • gf_Workspace.endpoint
      • gf_Workspace.fields
      • gf_Workspace.get_analysis()
      • gf_Workspace.get_invitations()
      • gf_Workspace.get_recents()
      • gf_Workspace.include_if_none
    • gf_WorkspaceInvitation
      • gf_WorkspaceInvitation.endpoint
      • gf_WorkspaceInvitation.fields
  • gofigr.watermarks module
    • DefaultWatermark
      • DefaultWatermark.apply()
      • DefaultWatermark.draw_identifier()
      • DefaultWatermark.draw_table()
      • DefaultWatermark.get_watermark()
    • Watermark
      • Watermark.apply()
    • add_margins()
    • stack_horizontally()
    • stack_vertically()
  • gofigr.annotators module
    • Annotator
      • Annotator.annotate()
    • BackendAnnotator
      • BackendAnnotator.annotate()
    • CellCodeAnnotator
      • CellCodeAnnotator.annotate_ip()
    • CellIdAnnotator
      • CellIdAnnotator.annotate_ip()
    • EnvironmentAnnotator
      • EnvironmentAnnotator.annotate()
    • GitAnnotator
      • GitAnnotator.annotate()
    • HistoryAnnotator
      • HistoryAnnotator.annotate()
    • IPythonAnnotator
      • IPythonAnnotator.annotate()
      • IPythonAnnotator.annotate_ip()
      • IPythonAnnotator.get_ip_extension()
    • NotebookMetadataAnnotator
      • NotebookMetadataAnnotator.annotate()
      • NotebookMetadataAnnotator.parse_from_databricks()
      • NotebookMetadataAnnotator.parse_from_vscode()
      • NotebookMetadataAnnotator.parse_metadata()
      • NotebookMetadataAnnotator.try_get_metadata()
    • NotebookNameAnnotator
    • PipFreezeAnnotator
      • PipFreezeAnnotator.annotate()
    • ScriptAnnotator
      • ScriptAnnotator.annotate()
    • SystemAnnotator
      • SystemAnnotator.annotate()
  • gofigr.widget module
    • AssetWidget
      • AssetWidget.get_link()
      • AssetWidget.show()
    • CompactWidget
      • CompactWidget.show()
    • DetailedWidget
      • DetailedWidget.show()
    • LiteStartupWidget
      • LiteStartupWidget.show()
    • MinimalWidget
      • MinimalWidget.show()
    • RevisionWidgetBase
      • RevisionWidgetBase.get_copy_link()
      • RevisionWidgetBase.get_download_link()
      • RevisionWidgetBase.get_text_copy_link()
    • StartupWidget
      • StartupWidget.get_link()
      • StartupWidget.show()
    • WidgetBase
      • WidgetBase.get_logo_b64()
      • WidgetBase.show()
    • timestamp_to_local_tz()
  • gofigr.backends module
    • GoFigrBackend
      • GoFigrBackend.add_interactive_watermark()
      • GoFigrBackend.close()
      • GoFigrBackend.figure_to_bytes()
      • GoFigrBackend.figure_to_html()
      • GoFigrBackend.find_figures()
      • GoFigrBackend.get_backend_name()
      • GoFigrBackend.get_default_figure()
      • GoFigrBackend.get_supported_image_formats()
      • GoFigrBackend.get_title()
      • GoFigrBackend.is_compatible()
      • GoFigrBackend.is_interactive()
      • GoFigrBackend.is_static()
    • get_all_function_arguments()
    • get_backend()
  • gofigr.backends.matplotlib module
    • MatplotlibBackend
      • MatplotlibBackend.close()
      • MatplotlibBackend.figure_to_bytes()
      • MatplotlibBackend.find_figures()
      • MatplotlibBackend.get_backend_name()
      • MatplotlibBackend.get_default_figure()
      • MatplotlibBackend.get_supported_image_formats()
      • MatplotlibBackend.get_title()
      • MatplotlibBackend.is_compatible()
      • MatplotlibBackend.is_interactive()
      • MatplotlibBackend.title_to_string()
    • SuppressPltWarnings
  • gofigr.backends.plotly module
    • PlotlyBackend
      • PlotlyBackend.add_interactive_watermark()
      • PlotlyBackend.close()
      • PlotlyBackend.figure_to_bytes()
      • PlotlyBackend.figure_to_html()
      • PlotlyBackend.find_figures()
      • PlotlyBackend.get_backend_name()
      • PlotlyBackend.get_default_figure()
      • PlotlyBackend.get_supported_image_formats()
      • PlotlyBackend.get_title()
      • PlotlyBackend.is_compatible()
      • PlotlyBackend.is_interactive()
  • gofigr.backends.plotnine module
    • PlotnineBackend
      • PlotnineBackend.close()
      • PlotnineBackend.figure_to_bytes()
      • PlotnineBackend.find_figures()
      • PlotnineBackend.get_backend_name()
      • PlotnineBackend.get_default_figure()
      • PlotnineBackend.get_supported_image_formats()
      • PlotnineBackend.get_title()
      • PlotnineBackend.is_compatible()
      • PlotnineBackend.is_interactive()
  • gofigr.backends.py3dmol module
    • Py3DmolBackend
      • Py3DmolBackend.add_interactive_watermark()
      • Py3DmolBackend.close()
      • Py3DmolBackend.figure_to_bytes()
      • Py3DmolBackend.figure_to_html()
      • Py3DmolBackend.find_figures()
      • Py3DmolBackend.get_backend_name()
      • Py3DmolBackend.get_default_figure()
      • Py3DmolBackend.get_supported_image_formats()
      • Py3DmolBackend.get_title()
      • Py3DmolBackend.is_compatible()
      • Py3DmolBackend.is_interactive()
    • WatermarkedView