Skip to content

Commit

Permalink
docs: include utility docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ancy Augustin authored and Ancy Augustin committed Nov 12, 2024
1 parent 2529a9b commit 29b7630
Show file tree
Hide file tree
Showing 3 changed files with 243 additions and 197 deletions.
4 changes: 4 additions & 0 deletions docs/api_reference/dataframe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ nisystemlink.clients.dataframe
.. automodule:: nisystemlink.clients.dataframe.models
:members:
:imported-members:

.. automodule:: nisystemlink.clients.dataframe.utilities
:members:
:imported-members:
19 changes: 19 additions & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,19 @@ With a :class:`.DataFrameClient` object, you can:

* Export table data in a comma-separated values (CSV) format.

Pandas Utility
~~~~~~~~~~~~~~

Utility functions for managing Pandas DataFrames and interacting with the DataFrame API include:

* Create a table from a pandas dataframe.

* Append pandas dataframe to an existing table.

* Query decimated data from a table as pandas dataframe.

* Query data from a table as pandas dataframe.

Examples
~~~~~~~~

Expand All @@ -121,6 +134,12 @@ Export data from a table
:language: python
:linenos:

Table operations using pandas dataframe

.. literalinclude:: ../examples/dataframe/pandas_dataframe_operations.py
:language: python
:linenos:

Spec API
-------

Expand Down
Loading

0 comments on commit 29b7630

Please sign in to comment.