File: api.rst

package info (click to toggle)
python-fedora 1.1.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,436 kB
  • sloc: python: 3,362; xml: 107; makefile: 14
file content (77 lines) | stat: -rw-r--r-- 1,454 bytes parent folder | download | duplicates (4)
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
=================
API Documentation
=================

This API Documentation is currently a catch-all.  We're going to merge the API
docs into the hand created docs as we have time to integrate them.

.. toctree::
   :maxdepth: 2

------
Client
------

.. automodule:: fedora.client
    :members: FedoraServiceError, ServerError, AuthError, AppError,
        FedoraClientError, FASError, CLAError, BodhiClientException,
        DictContainer

Generic Clients
===============

BaseClient
----------

.. autoclass:: fedora.client.BaseClient
    :members:
    :undoc-members:

ProxyClient
-----------

.. autoclass:: fedora.client.ProxyClient
    :members:
    :undoc-members:


OpenIdBaseClient
----------------

.. autoclass:: fedora.client.OpenIdBaseClient
    :members:
    :undoc-members:

.. autofunction:: fedora.client.openidbaseclient.requires_login

OpenIdProxyClient
-----------------

.. autoclass:: fedora.client.OpenIdProxyClient
    :members:
    :undoc-members:

Clients for Specific Services
=============================

Wiki
----

.. autoclass:: fedora.client.Wiki
    :members:
    :undoc-members:

-------
Service
-------

Transforming SQLAlchemy Objects into JSON
=========================================
.. automodule:: fedora.tg.json
    :members: jsonify_sa_select_results, jsonify_salist, jsonify_saresult,
        jsonify_set
    :undoc-members:

.. autoclass:: fedora.tg.json.SABase
    :members: __json__
    :undoc-members: