add examples

README.md

@@ -1,6 +1,63 @@
 # osc-ingest-tools
 python tools to assist with standardized data ingestion workflows
 
+### Install from PyPi
+
+```
+pip install osc-ingest-tools
+```
+
+### Examples
+
+```python
+>>> from osc_ingest_trino import *
+
+>>> import pandas as pd
+
+>>> data = [['tom', 10], ['nick', 15], ['juli', 14]]
+
+>>> df = pd.DataFrame(data, columns = ['First Name', 'Age In Years']).convert_dtypes()
+
+>>> df
+  First Name  Age In Years
+0        tom            10
+1       nick            15
+2       juli            14
+
+>>> enforce_sql_column_names(df)
+  first_name  age_in_years
+0        tom            10
+1       nick            15
+2       juli            14
+
+>>> enforce_sql_column_names(df, inplace=True)
+
+>>> df
+  first_name  age_in_years
+0        tom            10
+1       nick            15
+2       juli            14
+
+>>> df.info(verbose=True)
+<class 'pandas.core.frame.DataFrame'>
+RangeIndex: 3 entries, 0 to 2
+Data columns (total 2 columns):
+ #   Column        Non-Null Count  Dtype 
+---  ------        --------------  ----- 
+ 0   first_name    3 non-null      string
+ 1   age_in_years  3 non-null      Int64 
+dtypes: Int64(1), string(1)
+memory usage: 179.0 bytes
+
+>>> p = create_table_schema_pairs(df)
+
+>>> print(p)
+    first_name varchar,
+    age_in_years bigint
+
+>>> 
+```
+
 ### python packaging resources
 
 - https://packaging.python.org/