Welcome to GoFigr Client Library’s documentation!

Version: 0.17.0

Quick Start Guide:

• Getting started with GoFigr
  • Account registration
  • Client setup
    • Advanced configuration
    • Environment variables
  • Jupyter setup
    • Specifying names & IDs
  • Publishing your first figure
    • Publishing new revisions
• Compatibility
  • Library support
  • Customizing backends
• Jupyter Configuration
  • Simple
  • Complex
• Customization
  • QR code & watermarks
  • Annotators
    • Notebook name & path
    • Implementing custom annotators
  • Specifying annotators
  • Widgets
    • Detailed (default)
    • Compact
    • Minimal
• Organizing your analyses
  • Primary workspaces
  • Best practices
    • Notebook configuration
    • Auto-publish

Tips and tricks:

• Tips & tricks
  • Loading a published figure from stored pickle data

Module Reference:

• gofigr
  • gofigr package
    • Module contents
      • GoFigr
      • MethodNotAllowedError
      • UnauthorizedError
      • UserInfo
      • assert_one()
      • load_ipython_extension()
    • Submodules
    • gofigr.jupyter module
      • ApiId
      • FindByName
      • GfDisplayPublisher
      • Publisher
      • SuppressDisplayTrap
      • configure()
      • find_workspace_by_name()
      • from_config_or_env()
      • get_extension()
      • get_gofigr()
      • load_pickled_figure()
      • parse_model_instance()
      • parse_uuid()
      • proxy_callback()
      • publish()
      • require_configured()
    • gofigr.models module
      • Base64Field
      • CodeLanguage
      • DataField
      • DataType
      • Field
      • JSONField
      • LinkSharingStatus
      • LinkedEntityCollection
      • LinkedEntityField
      • LogItem
      • LogsMixin
      • MetadataProxyField
      • ModelMixin
      • NestedEntityField
      • NestedMixin
      • Recents
      • ShareableModelMixin
      • SharingUserData
      • ThumbnailMixin
      • Timestamp
      • WorkspaceMember
      • WorkspaceMembership
      • WorkspaceType
      • gf_Analysis
      • gf_ApiKey
      • gf_CodeData
      • gf_Data
      • gf_Figure
      • gf_ImageData
      • gf_MetadataProxy
      • gf_Revision
      • gf_TableData
      • gf_TextData
      • gf_Workspace
      • gf_WorkspaceInvitation
    • gofigr.watermarks module
      • DefaultWatermark
      • Watermark
      • add_margins()
      • stack_horizontally()
      • stack_vertically()
    • gofigr.annotators module
      • Annotator
      • BackendAnnotator
      • CellCodeAnnotator
      • CellIdAnnotator
      • EnvironmentAnnotator
      • HistoryAnnotator
      • NotebookMetadataAnnotator
      • NotebookNameAnnotator
      • PipFreezeAnnotator
      • SystemAnnotator
    • gofigr.widget module
      • CompactWidget
      • DetailedWidget
      • MinimalWidget
      • WidgetBase
      • timestamp_to_local_tz()

Indices and tables

• Index

• Module Index

• Search Page