IPython plugin for DataLinter

This is a Ipython magic that allows one to run DataLinter in Jupyter notebooks.

Installation

Make sure you have up-to-date stable versions of IPython and Jupyter. In order for the linter to work, both the Jupyter plugin and DataLinter (server in a Docker image) need to be installed in the system.

Jupyter plugin package

The Jupyter plugin can be installed with pip:

pip install datalintermagic

DataLinter

DataLinter installation is done with:

docker pull ghcr.io/zgornel/datalinter-compiled:latest

The command to start the linting server is:

docker run -d --rm -p10000:10000 \
    ghcr.io/zgornel/datalinter-compiled:latest \
        /datalinterserver/bin/datalinterserver \
            -i 0.0.0.0 \
            --config-path /datalinter/config/python_modelling_config.toml \
            --log-level info

If the server starts correctly, it should display something like:

[ Info: • Data linting server online @0.0.0.0:10000...

Quick start

%reload_ext datalintermagic
import numpy as np
X = np.random.random((10,100))

%add --tracked-variable X  --data-header --data-delim ','
%lintline X --show-stats

Further examples of linter usage in Jupyter are found in this notebook.

License

This code has an GNU GPLv3 license.

Contributing

To report a bug or request a feature, please file an issue.

Recent changes can be found in CHANGELOG.md.

References

[1] https://en.wikipedia.org/wiki/Lint_(software)