Skip to content

Commit ede5366

Browse files
committed
Added initial c8y_tk documentation.
1 parent 088b729 commit ede5366

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

docs/apidocs.rst

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,31 @@ These values can easily be combined, e.g. when constructing a measurement:
117117
Auxiliary Tools
118118
----------------
119119

120-
.. automodule:: c8y_tk
120+
The **Cumulocity Python API**'s standard packages (see :ref:`main-api-classes`
121+
and :ref:`object-models`) represent what the Cumulocity REST API provides.
122+
The `c8y_tk` (*Cumulocity toolkit*) module provides additional auxiliary tools
123+
that cover useful functionality beyond the REST API but applicable in many
124+
projects.
125+
126+
The `c8y_tk.notification2` module provides listener implementations that
127+
allow straightforward development of Notification 2.0 applications without
128+
additional overhead.
129+
130+
.. automodule:: c8y_tk.notification2
121131
:special-members: __init__
122-
:undoc-members:
132+
:members: Listener, AsyncListener, QueueListener, AsyncQueueListener
133+
134+
The `c8y_tk.analytics` module provides helper functions that allow easy
135+
transformation of a Cumulocity Series to Pandas' data frames and series as
136+
well as NumPy arrays.
137+
138+
.. automodule:: c8y_tk.analytics
139+
:special-members: __init__
140+
:members: to_numpy, to_data_frame, to_series
141+
142+
The `c8y_tk.app` module provides auxiliary tools for implementing both
143+
interactive and micro service applications.
144+
145+
.. automodule:: c8y_tk.app
146+
:special-members: __init__
147+
:members: CumulocityApp, SubscriptionListener

0 commit comments

Comments
 (0)