Welcome to GoFigr Client Library’s documentation!

Version: 0.13.1

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
• Jupyter Configuration Boilerplate
• Compatibility
  • Library support
  • Customizing backends
• Organizing your analyses
  • Primary workspaces
  • Best practices
    • Notebook configuration
    • Auto-publish
• Customization
  • QR code & watermarks
  • Annotators
    • Notebook name & path
    • Implementing custom annotators
  • Specifying annotators

Module Reference:

• gofigr
  • gofigr package
    • Submodules
    • gofigr.jupyter module
      • ApiId
      • FindByName
      • GfDisplayPublisher
      • Publisher
      • SuppressDisplayTrap
      • configure()
      • find_workspace_by_name()
      • from_config_or_env()
      • get_extension()
      • get_gofigr()
      • listener_callback()
      • parse_model_instance()
      • parse_uuid()
      • publish()
      • require_configured()
    • gofigr.models module
      • CodeData
      • CodeLanguage
      • Data
      • DataType
      • Field
      • ImageData
      • JSONField
      • LinkSharingStatus
      • LinkedEntityCollection
      • LinkedEntityField
      • LogItem
      • LogsMixin
      • MetadataProxy
      • ModelMixin
      • NestedEntityField
      • NestedMixin
      • Recents
      • ShareableModelMixin
      • SharingUserData
      • TableData
      • TextData
      • Timestamp
      • WorkspaceMember
      • WorkspaceMembership
      • WorkspaceType
      • gf_Analysis
      • gf_Figure
      • gf_Revision
      • gf_Workspace
    • gofigr.watermarks module
      • DefaultWatermark
      • Watermark
      • add_margins()
      • stack_horizontally()
      • stack_vertically()
    • Module contents
      • GoFigr
      • UnauthorizedError
      • UserInfo
      • assert_one()
      • load_ipython_extension()

Indices and tables

• Index

• Module Index

• Search Page