File: reference.rst

package info (click to toggle)
pydataverse 0.3.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,168 kB
  • sloc: python: 4,862; sh: 61; makefile: 13
file content (55 lines) | stat: -rw-r--r-- 1,048 bytes parent folder | download
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
Reference / API
=========================================

.. module:: pyDataverse

This part of the documentation covers all the interfaces / APIs of the pyDataverse modules.


Where pyDataverse depends on external libraries, we document the most
important right here and provide links to the canonical documentation outside of scope.


API Interface
-----------------------------

Access all of Dataverse APIs.

.. automodule:: pyDataverse.api
   :members:
   :special-members:


Models Interface
-----------------------------

Use all metadata models of the Dataverse data-types (`Dataverse`, `Dataset`
and `Datafile`). This includes import, export and manipulation.

.. automodule:: pyDataverse.models
  :inherited-members:


Utils Interface
-----------------------------

Helper functions.

.. automodule:: pyDataverse.utils
  :members:


Auth Helpers
-----------------------------

.. automodule:: pyDataverse.auth
  :members:


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

Custom exceptions.

.. automodule:: pyDataverse.exceptions
  :members: