version update with doc cleanup; sync with pypi version

Author: shouples

CHANGELOG.md

@@ -2,7 +2,11 @@ All notable changes will be documented here.
 
 ---
 
-## [1.0.0]() - 2022-04-25
+## `1.0.2`
+_2022-04-25_
+### **Fixed**
+* Updated minimum `python` version to `3.8` (down from `3.9.6` in 1.0.0)
+
 ### **Added**
 * Custom `IPython` formatter for [Noteable](https://app.noteable.io/) environments
 * Additional data type support for `display()` / `dx()`: 

README.md

@@ -1,49 +1,39 @@
 # dx
 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nteract/dx/main?urlpath=nteract/tree/examples)
-
 A Pythonic Data Explorer.
 
 ## Install
 
 For Python 3.8+:
-
 ```
-pip install dx
+pip install dx>=1.0.0
 ```
 
 ## Usage
 
-The `dx` library contains a simple helper function also called `dx`.
+The `dx` library allows for enabling/disabling DEX media type visualization with `dx.enable()` and `dx.display(data)` by setting a custom `IPython` formatter.
 
 ```python
-from dx import dx
-```
-
-`dx()` takes one positional argument, a `dataframe`.
+import dx
 
-```python
-dx.display(dataframe)
+dx.enable()
 ```
 
-The `dx(dataframe)` function will display the dataframe in
-[data explorer](https://github.com/nteract/data-explorer) mode:
-
-In the future, other data sources may be supported.
-
 ### Example
 
 ```python
-import dx
 import pandas as pd
 
-# Get happiness data and create a pandas dataframe
+# load randomized number/bool/string data
 df = pd.read_csv('examples/sample_data.csv')
-
-# Open data explorer with the happiness dataframe
 dx.display(df)
 ```
 
+Pass `index=True` to visualize the `.index` values of a dataframe as well as the column/row values:
+```python
+dx.display(df, index=True)
+```
+
 If you only wish to display a certain number of rows from the dataframe, use
 a context and specify the max rows (if set to None, all rows are used):
 

dx/__init__.py

@@ -2,4 +2,4 @@
 from .dx import *
 from .formatters import *
 
-__version__ = "1.0.1"
+__version__ = "1.0.2"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dx"
-version = "1.0.1"
+version = "1.0.2"
 description = "Python wrapper for Data Explorer"
 authors = ["Dave Shoup <dave.shoup@gmail.com>", "Kyle Kelley <rgbkrk@gmail.com>"]
 readme = "README.md"