summaryrefslogtreecommitdiff
path: root/docs/api.rst
blob: 4a0ff529775a4e07983b89ee62386349c23cd4af (plain)
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
.. _api:

===
API
===


.. module:: tablib

This part of the documentation covers all the interfaces of Tablib.  For
parts where Tablib depends on external libraries, we document the most
important right here and provide links to the canonical documentation.


--------------
Dataset Object
--------------


.. autoclass:: Dataset
   :inherited-members:


---------------
Databook Object
---------------


.. autoclass:: Databook
   :inherited-members:



---------
Functions
---------


.. autofunction:: detect

.. autofunction:: import_set


----------
Exceptions
----------


.. class:: InvalidDatasetType

    Raised when shit goes down.


.. class:: InvalidDimensions

    Raised when shit goes down.


.. class:: UnsupportedFormat

    Raised when shit goes down.


Now, go start some :ref:`Tablib Development <development>`.