File: classref.rst

package info (click to toggle)
python-pypump 0.7-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 512 kB
  • sloc: python: 3,153; makefile: 152
file content (88 lines) | stat: -rw-r--r-- 2,516 bytes parent folder | download | duplicates (2)
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
Class reference
====================

Essentials
----------

Classes doing most of the work.

.. autoclass:: pypump.PyPump
.. autoclass:: pypump.Client

Pump objects
------------

Classes representing pump.io objects:
        * :class:`Note <pypump.models.note.Note>`
        * :class:`Image <pypump.models.media.Image>`
        * :class:`Audio <pypump.models.media.Audio>`
        * :class:`Video <pypump.models.media.Video>`
        * :class:`Comment <pypump.models.comment.Comment>`
        * :class:`Person <pypump.models.person.Person>`
        * :class:`Inbox <pypump.models.feed.Inbox>`
        * :class:`Outbox <pypump.models.feed.Outbox>`
        * :class:`Lists <pypump.models.feed.Lists>`


.. autoclass:: pypump.models.note.Note
        :exclude-members: serialize
        :inherited-members:

.. autoclass:: pypump.models.media.Image
        :inherited-members:

        .. attribute:: thumbnail
        
                :class:`ImageContainer <pypump.models.media.ImageContainer>`
                holding information about the thumbnail image.

        .. attribute:: original

                :class:`ImageContainer <pypump.models.media.ImageContainer>`
                holding information about the original image.

.. autoclass:: pypump.models.media.Audio
        :inherited-members:

        .. attribute:: stream

                :class:`StreamContainer <pypump.models.media.StreamContainer>`
                holding information about the stream.

.. autoclass:: pypump.models.media.Video
        :inherited-members:

        .. attribute:: stream

                :class:`StreamContainer <pypump.models.media.StreamContainer>`
                holding information about the stream.


.. autoclass:: pypump.models.comment.Comment
        :inherited-members:

.. autoclass:: pypump.models.person.Person
        :inherited-members:

.. autoclass:: pypump.models.feed.Inbox
        :inherited-members:
.. autoclass:: pypump.models.feed.Outbox
        :inherited-members:
.. autoclass:: pypump.models.feed.Lists
        :inherited-members:

Low level objects
-----------------

Classes you probably don't need to know about.

.. autoclass:: pypump.models.media.ImageContainer
.. autoclass:: pypump.models.media.StreamContainer
.. .. autoclass:: pypump.models.PumpObject
.. .. autoclass:: pypump.models.Mapper

.. autoclass:: pypump.models.feed.Feed
        :inherited-members:
.. autoclass:: pypump.models.collection.Collection
        :inherited-members:
.. .. autoclass:: pypump.models.feed.ItemList