API Reference

Contents:

• SPy Core
  • Constants
    • seeq.spy.DEFAULT_WORKBOOK_PATH
    • seeq.spy.GLOBALS_AND_ALL_WORKBOOKS
    • seeq.spy.GLOBALS_ONLY
  • Classes
    • Session
    • Status
  • Global Attributes
    • client
    • options
    • server_version
    • session
    • user
  • Exception Types
    • SPyDependencyNotFound
    • SPyException
    • SPyKeyboardInterrupt
    • SPyRuntimeError
    • SPyTypeError
    • SPyValueError
    • SchedulePostingError
    • seeq.spy.errors.ApiException
  • The Core SPy Functions
    • archive()
    • login()
    • logout()
    • plot()
    • pull()
    • push()
    • search()
    • swap()
    • upgrade()
• SPy Submodules
  • SPy ACL
    • pull()
    • push()
  • SPy Add-ons
    • install()
    • search()
    • uninstall()
  • SPy Assets
    • Simple Asset Trees
    • Asset Tree Templates: Classes
    • Asset Tree Templates: Functions
  • SPy Docs
    • copy()
  • SPy Jobs
    • pull()
    • push()
    • schedule()
    • unschedule()
  • SPy Notifications
    • EmailRecipient
    • send_email()
  • SPy Utilities
    • get_data_lab_project_id()
    • get_data_lab_project_id_from_url()
    • get_data_lab_project_url()
    • get_open_port()
    • get_sdk_module_version_tuple()
    • get_server_version_tuple()
    • get_spy_module_version_tuple()
    • get_user_timezone()
    • get_workbook_id_from_url()
    • get_worksheet_id_from_url()
    • get_workstep_id_from_url()
    • is_guid()
    • is_sdk_module_version_at_least()
    • is_server_version_at_least()
    • is_spy_module_version_at_least()
    • is_valid_unit()
    • parse_str_time()
    • pull_worksheet_via_url()
    • time_abbreviation_to_ms_multiplier()
  • SPy Widgets
    • LogWindowWidget
    • SeeqItemSelect
    • WidgetLogHandler
  • SPy Workbooks
    • Constants
    • Classes
    • Functions