Skip to content

Commit

Permalink
add example usage to __init__.py
Browse files Browse the repository at this point in the history
  • Loading branch information
jgunstone committed Oct 4, 2024
1 parent 72b94c5 commit a17ff08
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/xlsxdatagrid/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@
#
# SPDX-License-Identifier: MIT

"""
root package for xlsxdatagrid
expected usage:
```py
import xlsxdatagrid as xdg
xdg.from_json(...) # outputs excel file from json data
xdg.from_dataframe(...) # outputs excel file from pandas dataframe
etc.
```
"""

from xlsxdatagrid.read import read_excel
from xlsxdatagrid.xlsxdatagrid import (
from_pydantic_object,
Expand Down

0 comments on commit a17ff08

Please sign in to comment.