Project

General

Profile

Actions

Story #18799

open

Strategy to tie the Python SDK to the API docs

Added by Peter Amstutz 6 months ago. Updated 6 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-

Description

write script that

  • takes the discovery document
  • produces Python stubs with docstrings, type annotations etc corresponding to the google api client
  • adds the stub files to the python SDK
  • runs pydoc

The goal is for the methods/objects found under arvados.api() (generated on the fly by google api client) to be browsable in pydoc.


Related issues

Related to Arvados - Support #18263: Plan to document the Python SDKResolvedPeter Amstutz

Actions
Related to Arvados Epics - Story #18800: Update Python SDK documentationNew06/01/202208/31/2022

Actions
Actions #1

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #2

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #3

Updated by Peter Amstutz 6 months ago

Actions #4

Updated by Peter Amstutz 6 months ago

  • Related to Story #18800: Update Python SDK documentation added
Actions

Also available in: Atom PDF