From 65a84ec3801f6b76ccc2e6af07511851b4dc3aba Mon Sep 17 00:00:00 2001 From: Brett Smith Date: Mon, 20 Nov 2023 16:31:17 -0500 Subject: [PATCH] 18800: Add docstring to arvados.__init__ This is mostly intended to help orient people reading the web documentation. Arvados-DCO-1.1-Signed-off-by: Brett Smith --- sdk/python/arvados/__init__.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/sdk/python/arvados/__init__.py b/sdk/python/arvados/__init__.py index 8a7a151ee0..e90f381298 100644 --- a/sdk/python/arvados/__init__.py +++ b/sdk/python/arvados/__init__.py @@ -1,6 +1,23 @@ # Copyright (C) The Arvados Authors. All rights reserved. # # SPDX-License-Identifier: Apache-2.0 +"""Arvados Python SDK + +This module provides the entire Python SDK for Arvados. The most useful modules +include: + +* arvados.api - After you `import arvados`, you can call `arvados.api.api` as + `arvados.api` to construct a client object. + +* arvados.collection - The `arvados.collection.Collection` class provides a + high-level interface to read and write collections. It coordinates sending + data to and from Keep, and synchronizing updates with the collection object. + +* arvados.util - Utility functions to use mostly in conjunction with the API + client object and the results it returns. + +Other submodules provide lower-level functionality. +""" import logging as stdliblog import os -- 2.30.2