Pygrister docs.

• Pygrister: a Python client for the Grist API.
  • The many Grist IDs, explained.
• An overview of the GristApi class.
  • API call return values.
  • Grist IDs in Pygrister functions.
  • Record format in Pygrister.
• Pygrister configuration.
  • Where configuration is stored.
  • Runtime configuration.
  • Working with the configuration.
    • Changing configuration at runtime.
  • Configuration keys.
• Advanced configuration topics.
  • Support for the self-hosted Grist.
  • Support for Grist Desktop.
  • App-specific configuration.
  • “Cross-site” access.
  • Extending the configuration.
  • Custom configurators.
• Type checking and converting.
  • Converter functions.
    • Caveats about converters.
  • Register a converter.
  • Where converters are applied.
  • Handling conversion errors.
    • A note on converting date/times.
• Various and sundry.
  • Inspecting and troubleshooting the API call.
  • Errors vs Status codes.
  • The ok attribute.
  • Dry run.
  • Safe mode.
  • Additional arguments for the request.
  • Using Requests sessions in Pygrister.
• Support for the Grist SCIM apis.
  • SCIM is not for everyone.
  • Sometimes, SCIM is different.
  • What about the old user-related apis?
  • Wait, did you say pagination?!
• Grist/Pygrister/Gry API list.
  • Service Accounts
  • Users and SCIM
  • Groups (Scim)
  • Roles (Scim)
  • Active user, session, api key
  • Teams (organisations)
  • Workspaces
  • Documents
  • Tables
  • Columns
  • Records
  • Attachments
  • Webhooks
  • Templates
  • Widgets and Forms
  • Sql
  • Deprecated / not implemented
• Pygrister API reference.
  • Pygrister: a Python client for the Grist API.
  • get_config()
  • check_safemode()
  • Paginator
  • The main GristApi class.
    • GristApi
      • GristApi.in_converter
      • GristApi.out_converter
      • GristApi.reconfig()
      • GristApi.update_config()
      • GristApi.make_server()
      • GristApi.open_session()
      • GristApi.close_session()
      • GristApi.ok
      • GristApi.inspect()
      • GristApi.list_service_accounts()
      • GristApi.add_service_account()
      • GristApi.see_service_account()
      • GristApi.update_service_account()
      • GristApi.delete_service_account()
      • GristApi.update_service_account_key()
      • GristApi.delete_service_account_key()
      • GristApi.see_user()
      • GristApi.see_myself()
      • GristApi.see_profile()
      • GristApi.update_profile_name()
      • GristApi.update_profile_locale()
      • GristApi.see_apikey()
      • GristApi.new_apikey()
      • GristApi.delete_apikey()
      • GristApi.see_session()
      • GristApi.see_session_users()
      • GristApi.update_session_user()
      • GristApi.list_users()
      • GristApi.list_users_raw()
      • GristApi.add_user()
      • GristApi.update_user_override()
      • GristApi.update_user()
      • GristApi.enable_user()
      • GristApi.delete_user()
      • GristApi.delete_myself()
      • GristApi.search_users()
      • GristApi.search_users_raw()
      • GristApi.bulk_users()
      • GristApi.see_scim_schemas()
      • GristApi.see_scim_config()
      • GristApi.see_scim_resources()
      • GristApi.see_group()
      • GristApi.list_groups()
      • GristApi.list_groups_raw()
      • GristApi.add_group()
      • GristApi.update_group_override()
      • GristApi.update_group()
      • GristApi.delete_group()
      • GristApi.search_groups()
      • GristApi.search_groups_raw()
      • GristApi.see_role()
      • GristApi.list_roles()
      • GristApi.list_roles_raw()
      • GristApi.update_role_override()
      • GristApi.update_role()
      • GristApi.list_team_sites()
      • GristApi.see_team()
      • GristApi.see_team_usage()
      • GristApi.update_team()
      • GristApi.delete_team_old()
      • GristApi.delete_team()
      • GristApi.list_team_users()
      • GristApi.update_team_users()
      • GristApi.list_workspaces()
      • GristApi.add_workspace()
      • GristApi.see_workspace()
      • GristApi.update_workspace()
      • GristApi.delete_workspace()
      • GristApi.trash_workspace()
      • GristApi.list_workspace_users()
      • GristApi.update_workspace_users()
      • GristApi.add_doc()
      • GristApi.see_doc()
      • GristApi.update_doc()
      • GristApi.delete_doc()
      • GristApi.trash_doc()
      • GristApi.list_doc_history()
      • GristApi.compare_doc_history()
      • GristApi.delete_doc_history()
      • GristApi.fork_doc()
      • GristApi.compare_docs()
      • GristApi.list_proposals()
      • GristApi.add_proposal()
      • GristApi.apply_proposal()
      • GristApi.move_doc()
      • GristApi.copy_doc()
      • GristApi.replace_doc()
      • GristApi.reload_doc()
      • GristApi.flush_doc()
      • GristApi.assign_doc()
      • GristApi.enable_doc()
      • GristApi.pin_doc()
      • GristApi.set_recovery_mode()
      • GristApi.list_doc_users()
      • GristApi.list_viewas_users()
      • GristApi.update_doc_users()
      • GristApi.download_sqlite()
      • GristApi.upload_sqlite()
      • GristApi.download_table()
      • GristApi.download_excel()
      • GristApi.download_csv()
      • GristApi.download_schema()
      • GristApi.list_snapshots()
      • GristApi.delete_snapshots()
      • GristApi.see_timing()
      • GristApi.start_timing()
      • GristApi.stop_timing()
      • GristApi.list_records()
      • GristApi.add_records()
      • GristApi.update_records()
      • GristApi.add_update_records()
      • GristApi.list_tables()
      • GristApi.add_tables()
      • GristApi.update_tables()
      • GristApi.delete_tables()
      • GristApi.list_cols()
      • GristApi.add_cols()
      • GristApi.update_cols()
      • GristApi.add_update_cols()
      • GristApi.delete_column()
      • GristApi.delete_rows()
      • GristApi.list_attachments()
      • GristApi.upload_attachment()
      • GristApi.upload_attachments()
      • GristApi.upload_restore_attachments()
      • GristApi.see_attachment()
      • GristApi.download_attachment()
      • GristApi.download_attachments()
      • GristApi.delete_unused_attachments()
      • GristApi.see_attachment_store()
      • GristApi.update_attachment_store()
      • GristApi.list_store_settings()
      • GristApi.transfer_attachments()
      • GristApi.see_transfer_status()
      • GristApi.verify_attachment_usage()
      • GristApi.verify_attachment_files()
      • GristApi.list_webhooks()
      • GristApi.add_webhooks()
      • GristApi.update_webhook()
      • GristApi.delete_webhook()
      • GristApi.empty_payloads_queue()
      • GristApi.list_templates()
      • GristApi.see_template()
      • GristApi.list_widgets()
      • GristApi.see_form()
      • GristApi.run_sql()
      • GristApi.run_sql_with_args()
  • Configuration mechanism.
    • Pygrister configuration engine.
    • apikey2output()
  • Api call engine.
    • Pygrister Api call engine.
    • Apiresp
    • ApiCaller
      • ApiCaller.session
      • ApiCaller.request_options
      • ApiCaller.apicalls
      • ApiCaller.dry_run
      • ApiCaller.request
      • ApiCaller.response
      • ApiCaller.ok
      • ApiCaller.open_session()
      • ApiCaller.close_session()
      • ApiCaller.response_as_json()
      • ApiCaller.apicall()
      • ApiCaller.inspect()
  • Pygrister exceptions.
    • Pygrister exception hierarchy.
    • GristApiException
    • GristApiNotConfigured
    • GristApiNotImplemented
    • GristApiInSafeMode
• The Gry command line tool.
  • Standalone distribution.
  • Architecture and online help.
  • Common options.
    • Meta-content options.
    • Output type control.
    • ID specification.
  • Interactive prompt.
  • Exit codes.
    • Non-standard Http codes for connection errors.
  • Configuration.
    • Gry configuration keys.
    • Where the Gry configuration is stored.
    • Differences with Pygrister configuration.
• Advanced Gry topics.
  • Data type converters.
  • Passing additional arguments to Requests.
  • The gry Python shell.
  • Caveat and limitations.