Merge pull request #27 from cparmet/docs-updates

Docs fixes and enhancements

Author: cparmet

README.md

@@ -1,6 +1,8 @@
-# 🐼🩺 Pandas Checks
+# Pandas Checks
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pandas-checks)
-
+  
+<img src="https://raw.githubusercontent.com/cparmet/pandas-checks/main/static/pandas-check-gh-social.jpg" alt="Banner image for Pandas Checks">  
+  
 ## Introduction
 **Pandas Checks** is a Python library for data science and data engineering. It adds non-invasive health checks for Pandas method chains.
 
@@ -52,14 +54,14 @@ def clean_iris_data(iris: pd.DataFrame) -> pd.DataFrame:
     )
 ```
 
-But what if you want to see what's happening to the data along the way? Or understand why a new `iris` data file makes the cleaned data look weird? Or make the pipeline more robust? 
+But what if you want to make the pipeline more robust? Or see what's happening to the data as it flows down? Or understand why your new `iris` CSV suddenly makes the cleaned data look weird? 
 
 You can add some `.check` steps.
 
 ```python
 
 (
-    pd.read_csv('iris.csv')
+    iris
 
     # Validate that the data doesn't violate any assumptions
     .check.assert_data(lambda df: (df['sepal_width']> 0).all(), fail_message="Sepal width can't be negative")  

docs/index.md

@@ -1,5 +1,7 @@
 # About
-
+  
+<img src="https://raw.githubusercontent.com/cparmet/pandas-checks/main/static/pandas-check-gh-social.jpg" alt="Banner image for Pandas Checks">  
+  
 ## Introduction
 
 **Pandas Checks** is a Python library for data science and data engineering. It adds non-invasive health checks for Pandas method chains.
@@ -15,7 +17,8 @@ That way you don't need to chop up a method chain, or create intermediate variab
 
 As Fleetwood Mac says, you would never break the chain.
 
-[![Fleetwood Mac video for The Chain](https://img.youtube.com/vi/xwTPvcPYaOo/0.jpg)](https://www.youtube.com/watch?v=xwTPvcPYaOo)
+<a href="https://www.youtube.com/watch?v=xwTPvcPYaOo"><img src="https://raw.githubusercontent.com/cparmet/pandas-checks/main/static/fleetwood-mac-the-chain.jpg" alt="Fleetwood Mac YouTube video for The Chain" target="_blank"></a>
+  
 
 ## Giving feedback and contributing
 

docs/usage.md

@@ -39,14 +39,14 @@ def clean_iris_data(iris: pd.DataFrame) -> pd.DataFrame:
     )
 ```
 
-But what if you want to see what's happening to the data along the way? Or understand why a new `iris` data file makes the cleaned data look weird? Or make the pipeline more robust? 
-  
+But what if you want to make the pipeline more robust? Or see what's happening to the data as it flows down? Or understand why your new `iris` CSV suddenly makes the cleaned data look weird? 
+    
 You can add some `.check` steps.
 
 ```python
 
 (
-    pd.read_csv('iris.csv')
+    iris
 
     # Validate that the data doesn't violate any assumptions
     .check.assert_data(lambda df: (df['sepal_width']> 0).all(), fail_message="Sepal width can't be negative")  

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pandas-checks"
-version = "0.1.7"
+version = "0.1.8"
 description = "Non-invasive health checks for Pandas method chains"
 authors = ["Chad Parmet <[email protected]>"]
 readme = "README.md"