File: modules.rst

package info (click to toggle)
python-internetarchive 5.7.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,028 kB
  • sloc: python: 8,392; makefile: 235; xml: 180
file content (179 lines) | stat: -rw-r--r-- 3,813 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
.. _modules:

Module Documentation
====================

This section contains complete reference documentation for all modules, classes, and methods in the ``internetarchive`` package. For a gentler introduction with examples, see :ref:`python-lib`.

Core Modules
------------

These modules provide the main functionality for interacting with archive.org.

.. _api-module:

internetarchive.api module
~~~~~~~~~~~~~~~~~~~~~~~~~~

The convenience module providing simple functions for common tasks.

.. automodule:: internetarchive.api
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

.. _session-module:

internetarchive.session module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The session management module for persisting configuration and connections.

.. automodule:: internetarchive.session
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

.. _item-module:

internetarchive.item module
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Modules for working with archive.org items and collections.

.. automodule:: internetarchive.item
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

.. _account-module:

internetarchive.account module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Module for managing an archive.org account (requires admin privileges).

.. automodule:: internetarchive.account
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

.. _search-module:

internetarchive.search module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Modules for searching and retrieving items from archive.org.

.. automodule:: internetarchive.search
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

File Operations
---------------

Modules for working with files and specific file operations.

.. automodule:: internetarchive.files
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

Request Handling
----------------

Modules for making HTTP requests to archive.org services.

.. automodule:: internetarchive.iarequest
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

Task and Catalog Management
---------------------------

Modules for working with archive.org tasks and the catalog system.

.. automodule:: internetarchive.catalog
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

Authentication and Configuration
--------------------------------

Modules for authentication, configuration, and utility functions.

.. automodule:: internetarchive.auth
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

.. automodule:: internetarchive.config
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

Utility and Supporting Modules
------------------------------

Internal utilities and supporting modules.

.. automodule:: internetarchive.utils
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

.. automodule:: internetarchive.exceptions
   :members:
   :undoc-members:
   :show-inheritance:
   :noindex:

CLI Modules (Internal)
----------------------

.. note::
   These modules are primarily used by the command-line interface and are considered
   internal to the package. For using the CLI, see :ref:`cli`.

.. automodule:: internetarchive.cli
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :noindex:

Complete Package Reference
--------------------------

For a complete listing of all modules and classes:

.. automodule:: internetarchive
   :members:
   :undoc-members:
   :show-inheritance:
   :noindex: