semvec/pypi-packages huggingface dataset:
diginlineprofiler 0.1.2
Inline data profiles for pandas dataframes in jupyter
License: BSD-3-Clause
Requires Python: >=3.7
Keywords: Jupyter,JupyterLab,JupyterLab3

# ProfileInline

<!-- [![Build Status](https://travis-ci.org/cmudig/ProfileInline.svg?branch=master)](https://travis-ci.org/cmudig/diginlineprofiler)
[![codecov](https://codecov.io/gh/cmudig/ProfileInline/branch/master/graph/badge.svg)](https://codecov.io/gh/cmudig/ProfileInline) -->

Inline data profiles to help you understand your data with one function.

Check out [AutoProfiler](https://github.com/cmudig/AutoProfiler) for a version that updates automatically when you change your data.

## Installation

You can install using `pip`:

```bash
pip install diginlineprofiler
```

## Usage

Import in a Jupyter notebook or lab then pass in any pandas dataframe.

```python
from diginlineprofiler import Visualizer as plot # here we rename to plot but can be anything

# df must be a pandas dataframe!
plot(df)
```

![screenshot of InlineProfiler](https://raw.githubusercontent.com/cmudig/ProfileInline/main/.github/screenshots/inline-preview.png)




## Development Installation

Create a dev environment:

```bash
conda create -n diginlineprofiler-dev -c conda-forge nodejs yarn python jupyterlab jupyter-packaging
conda activate diginlineprofiler-dev
```

Install the python. This will also build the TS package.

```bash
pip install -e .
```

When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:

```
jupyter labextension develop --overwrite .
npm run build
```

### How to see your changes

#### Jupyter Lab:

If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
terminals to watch for changes in the extension's source and automatically rebuild the widget.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
npm run watch
# Run JupyterLab in another terminal
jupyter lab
```

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

#### Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.