Project

General

Profile

Actions

Idea #19791

closed

Write Python SDK overview

Added by Brett Smith over 1 year ago. Updated over 1 year ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
SDKs
Target version:
Story points:
-
Release relationship:
Auto

Description

Write a document that explains:

  • The Python SDK dynamically implements interfaces from the Arvados API.
  • Every resource type has a corresponding class.
  • API methods can be called as instance methods.
  • Arguments to methods are passed as keyword arguments.
  • Explain some of the abstractions like calling .execute().
  • Link to documentation for the Arvados API and google-api-python-client for further reading as appropriate.

The goal is for this to be a single document that helps people understand the patterns that the API client follows and how it relates to the Arvados API.

IMO you can implement this by building out the current "Examples" page of the documentation. The orientation should be high-level enough to stay useful even after we have full reference documentation from issue #18799.


Subtasks 1 (1 open0 closed)

Task #19800: Review 19791-python-api-overviewIn ProgressPeter Amstutz11/25/2022Actions

Related issues

Related to Arvados - Feature #6865: [Documentation] Higher Level Python SDK Reference PageDuplicate08/03/2015Actions
Actions

Also available in: Atom PDF