forked from burnash/gspread
/
index.txt
74 lines (51 loc) · 1.6 KB
/
index.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.. gspread documentation master file, created by
sphinx-quickstart on Thu Dec 15 14:44:32 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
gspread API Reference
=====================
`gspread <https://github.com/burnash/gspread>`_ is a simple `Google Spreadsheets`_ API wrapper.
.. _Google Spreadsheets: http://www.google.com/drive/apps.html
.. module:: gspread
.. contents:: :local:
Main Interface
--------------
.. autofunction:: login
.. autofunction:: authorize
.. autoclass:: Client
:members:
Models
------
The models represent common spreadsheet objects: :class:`a spreadsheet <Spreadsheet>`,
:class:`a worksheet <Worksheet>` and :class:`a cell <Cell>`.
.. note::
The classes described below should not be instantiated by end-user. Their
instances result from calling other objects' methods.
.. autoclass:: Spreadsheet
:members:
.. autoclass:: Worksheet
:members:
.. autoclass:: Cell
:members:
Exceptions
----------
.. autoexception:: GSpreadException
.. autoexception:: AuthenticationError
.. autoexception:: SpreadsheetNotFound
.. autoexception:: WorksheetNotFound
.. autoexception:: NoValidUrlKeyFound
.. autoexception:: UpdateCellError
.. autoexception:: RequestError
Internal Modules
----------------
Following modules are for internal use only.
.. automodule:: gspread.httpsession
:members: HTTPSession
.. automodule:: gspread.urls
:members: construct_url
.. _github issue: https://github.com/burnash/gspread/issues
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`