fg-data-profiling 4.19.0__tar.gz

fg_data_profiling-4.19.0/CONTRIBUTING.md

@@ -0,0 +1,102 @@
+## How to contribute to Data-Profiling
+
+Data-profiling aims to ease exploratory data analysis for structured datasets, including time-series. 
+Our focus is to provide users with useful and robust statistics for such datasets encountered in industry, academia and elsewhere.
+Data-profiling is open-source and stimulates contributions from passionate community users.
+
+
+#### Themes to contribute
+In line with our aim, we identify the following themes:
+
+- **Exploratory data analysis**: 
+  The core of the package is a dataset summarization by its main characteristics, which is complemented with warnings on data issues and visualisations.
+
+  _Suggestions for contribution_: 
+  Extend the support of more data types (think of paths, location or GPS coordinates and ordinal data types),
+  text data (e.g. encoding, vocabulary size, spelling errors, language detection), 
+  time series analysis, 
+  or even images (e.g. dimensions, EXIF).
+  
+  _Related_: [#7][i7], [#129][i129], [#190][i190], [#204][i204] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
+
+- **Stability, Performance and Restricted environment compatibility:** 
+  Data exploration takes place in all kinds of conditions, on the latest machine learning platforms with enormous dataset to managed environments in large corporations.
+  `data-profiling` helps analysts, researchers and engineers alike in these cases.
+  We do this by fixing bugs, improving performance on big datasets and adding environment compatibility.
+  
+  _Suggestions for contribution (Performance)_: 
+  Perform concurrency analysis or profile execution times and leverage the gained insights for improved performance (e.g. multiprocessing, cython, numba) or test the performance of `data-profiling` with [big data sets](https://www.stats.govt.nz/large-datasets/csv-files-for-download/) and corresponding commonly used data formats (such as parquet). 
+  
+  _Suggestions for contribution (Stability)_: 
+  Either review the code and add tests or watch the [issues page](https://github.com/Data-Centric-AI-Community/data-profiling/issues) and [Stackoverflow tag](https://stackoverflow.com/questions/tagged/ydata-profiling) to find current issues.
+     
+  _Related_: [#98][i98], [#122][i122] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
+
+- **Interaction, presentation and user experience**: 
+  As `data-profiling` eases exploratory data analysis, working with the package should reflect that.
+  Interaction and user experience plays a central role in working with the package.
+  Working on interactive and static features is possible through the modular nature of the package: the user can configure which features to use.
+
+  _Suggestions for contribution (interactivity)_:
+  Interactivity allows for more user friendly applications, including but not limited to on demand analysis (don't compute what you don't want to see) and interactive histograms and correlations. 
+  This is ideal for smaller datasets, where we can compute this on-the-fly. 
+  `ipywidgets` would be a great place to start (e.g. [widget based view](https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20List.html)).
+
+  _Suggestions for contribution (presentation)_:
+  Other forms of distribution than HTML (for example PDF or packaged as an GUI application via [PyQt](https://riverbankcomputing.com/software/pyqt/intro))
+  Users should be able to share reports (improve size of labels in graph, add explanations to correlation matrices and allow for styling/branding).
+
+  _Related_: [#161][i161], [#175][i175], [#191][i191] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
+
+- **Community**: 
+  The success of this package demonstrates the power of sharing and working together.
+  You are welcome as part of this community.
+  
+  _Suggestions for contribution_:
+  Share with us if this package is of value to you, let us know [in our community](https://discord.com/invite/mw7xjJ7b7s).
+  We are interested in how you use `data-profiling` in your work.
+  
+  _Related_: [#87][i87] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
+
+- **Machine learning:** 
+  `data-profiling` is not a machine learning package, even though many of our users use EDA as a step prior to developing their models.
+  Our focus lies in the exploratory data analysis.
+  Any functionality that enables machine learning applications by more effective data profiling, is welcome.
+
+  _Related_: [#124][i124], [#173][i173], [#198][i198] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on Github under [Issues](https://github.com/Data-Centric-AI-Community/data-profiling/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose). 
+If possible, use the relevant bug report templates to create the issue. 
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new Github pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. 
+Include the relevant issue number if applicable.
+
+
+#### Acknowledgements
+
+We would like to thank everyone who has helped getting us to where we are now.
+
+See the [Contributor Graph](https://github.com/Data-Centric-AI-Community/data-profiling/graphs/contributors)
+
+[i7]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/7
+[i129]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/129
+[i190]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/190
+[i204]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/204
+[i98]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/98
+[i122]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/122
+[i124]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/24
+[i173]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/173
+[i198]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/198
+[i87]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/87
+[i161]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/161
+[i175]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/175
+[i191]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/191
+

fg_data_profiling-4.19.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jos Polfliet, 2019-2021 Simon Brugman, 2022-Present YData Labs Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fg_data_profiling-4.19.0/MANIFEST.in

@@ -0,0 +1,27 @@
+# Requirements
+include requirements*.txt
+
+# Include license, Readme, etc.
+include LICENSE
+include *.md
+
+# Templates and static resources
+recursive-include src/data_profiling/report/presentation/flavours/html/templates *.html *.js *.css
+
+# Configuration
+include src/data_profiling/*.yaml
+
+# Spark Dev venv
+recursive-include venv *.yml
+
+# Exclude development, docs, testing and example code
+exclude .pre-commit-config.yaml
+exclude commitlint.config.js
+exclude .releaserc.json
+exclude Makefile make.bat
+exclude docs examples tests docsrc .devcontainer
+recursive-exclude docs *
+recursive-exclude docsrc *
+recursive-exclude examples *
+recursive-exclude tests *
+recursive-exclude .devcontainer *

fg_data_profiling-4.19.0/PKG-INFO

@@ -0,0 +1,362 @@
+Metadata-Version: 2.4
+Name: fg-data-profiling
+Version: 4.19.0
+Summary: Generate profile report for pandas DataFrame
+Author-email: YData Labs Inc <opensource@ydata.ai>
+Project-URL: Homepage, https://ydata.ai
+Project-URL: Repository, https://github.com/Data-Centric-AI-Community/data-profiling
+Keywords: pandas,data-science,data-analysis,python,jupyter,ipython
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Healthcare Industry
+Classifier: Topic :: Scientific/Engineering
+Classifier: Framework :: IPython
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: scipy<1.17,>=1.8
+Requires-Dist: pandas!=1.4.0,<3.0,>1.5
+Requires-Dist: matplotlib<=3.10,>=3.5
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: PyYAML<6.1,>=6.0.3
+Requires-Dist: jinja2<3.2,>=3.1.6
+Requires-Dist: visions[type_image_path]<0.8.2,>=0.7.5
+Requires-Dist: numpy<2.4,>=1.22
+Requires-Dist: minify-html>=0.15.0
+Requires-Dist: filetype>=1.0.0
+Requires-Dist: phik<0.13,>=0.12.5
+Requires-Dist: requests<3,>=2.32.0
+Requires-Dist: tqdm<5,>=4.66.3
+Requires-Dist: seaborn<0.14,>=0.10.1
+Requires-Dist: multimethod<2,>=1.4
+Requires-Dist: statsmodels<1,>=0.13.2
+Requires-Dist: typeguard<5,>=4
+Requires-Dist: imagehash==4.3.2
+Requires-Dist: wordcloud>=1.9.4
+Requires-Dist: dacite<2,>=1.9
+Requires-Dist: numba<0.63,>=0.60
+Provides-Extra: dev
+Requires-Dist: black>=20.8b1; extra == "dev"
+Requires-Dist: isort>=5.0.7; extra == "dev"
+Requires-Dist: pre-commit>=2.8.2; extra == "dev"
+Requires-Dist: virtualenv>=20.0.33; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: myst-parser>=0.18.1; extra == "dev"
+Requires-Dist: sphinx_rtd_theme>=0.4.3; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints>=1.10.3; extra == "dev"
+Requires-Dist: sphinx-multiversion>=0.2.3; extra == "dev"
+Requires-Dist: autodoc_pydantic; extra == "dev"
+Requires-Dist: standard-imghdr; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs<1.7.0,>=1.6.0; extra == "docs"
+Requires-Dist: mkdocs-material<10.0.0,>=9.0.12; extra == "docs"
+Requires-Dist: mkdocs-material-extensions<2.0.0,>=1.1.1; extra == "docs"
+Requires-Dist: mkdocs-table-reader-plugin<=2.2.0; extra == "docs"
+Requires-Dist: mike<2.2.0,>=2.1.1; extra == "docs"
+Requires-Dist: mkdocstrings[python]<1.0.0,>=0.20.0; extra == "docs"
+Requires-Dist: mkdocs-badges; extra == "docs"
+Provides-Extra: notebook
+Requires-Dist: jupyter>=1.0.0; extra == "notebook"
+Requires-Dist: ipywidgets>=7.5.1; extra == "notebook"
+Provides-Extra: spark
+Requires-Dist: pyspark>=4.0; extra == "spark"
+Requires-Dist: pyarrow>=4.0.0; extra == "spark"
+Requires-Dist: pandas>1.1; extra == "spark"
+Requires-Dist: numpy>=1.16.0; extra == "spark"
+Requires-Dist: visions[type_image_path]<0.7.7,>=0.7.5; extra == "spark"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage<8,>=6.5; extra == "test"
+Requires-Dist: codecov; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: nbval; extra == "test"
+Requires-Dist: pyarrow; extra == "test"
+Requires-Dist: twine>=3.1.1; extra == "test"
+Requires-Dist: kaggle; extra == "test"
+Provides-Extra: unicode
+Requires-Dist: tangled-up-in-unicode==0.2.0; extra == "unicode"
+Dynamic: license-file
+
+# data-profiling
+
+[![Build Status](https://github.com/ydataai/pandas-profiling/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/ydataai/pandas-profiling/actions/workflows/tests.yml)
+[![PyPI download month](https://img.shields.io/pypi/dm/data-profiling.svg)](https://pypi.python.org/pypi/data-profiling/)
+[![](https://pepy.tech/badge/pandas-profiling)](https://pypi.org/project/data-profiling/)
+[![Code Coverage](https://codecov.io/gh/ydataai/pandas-profiling/branch/master/graph/badge.svg?token=gMptB4YUnF)](https://codecov.io/gh/ydataai/pandas-profiling)
+[![Release Version](https://img.shields.io/github/release/ydataai/pandas-profiling.svg)](https://github.com/ydataai/pandas-profiling/releases)
+[![Python Version](https://img.shields.io/pypi/pyversions/data-profiling)](https://pypi.org/project/data-profiling/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
+<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=cb7e69df-af81-4352-809a-d4251756affc" />
+
+<p align="center"><img width="300" src="https://assets.ydata.ai/oss/data-profiling_black.png" alt="YData Profiling Logo"></p>
+
+<p align="center">
+  <a href="https://data-profiling.ydata.ai/docs/master/">Documentation</a>
+  |
+  <a href="https://tiny.ydata.ai/dcai-data-profiling">Discord</a>
+  | 
+  <a href="https://stackoverflow.com/questions/tagged/pandas-profiling+or+data-profiling">Stack Overflow</a>
+  |
+  <a href="https://data-profiling.ydata.ai/docs/master/pages/reference/changelog.html#changelog">Latest changelog</a>
+
+</p>
+
+<p align="center">
+  Do you like this project? Show us your love and <a href="https://engage.ydata.ai">give feedback!</a>
+</p>
+
+`data-profiling` primary goal is to provide a one-line Exploratory Data Analysis (EDA) experience in a consistent and fast solution. Like pandas `df.describe()` function, that is so handy, data-profiling delivers an extended analysis of a DataFrame while allowing the data analysis to be exported in different formats such as **html** and **json**.
+
+The package outputs a simple and digested analysis of a dataset, including **time-series** and **text**.
+
+> **Looking for a scalable solution that can fully integrate with your database systems?**<br>
+> Leverage YData Fabric Data Catalog to connect to different databases and storages (Oracle, snowflake, PostGreSQL, GCS, S3, etc.) and leverage an interactive and guided profiling experience in Fabric. Check out the [Community Version](http://ydata.ai/register?utm_source=data-profiling&utm_medium=documentation&utm_campaign=YData%20Fabric%20Community).
+
+## ▶️ Quickstart
+
+### Install
+```cmd
+pip install data-profiling
+```
+or
+```cmd
+conda install -c conda-forge data-profiling
+```
+### Start profiling
+
+Start by loading your pandas `DataFrame` as you normally would, e.g. by using:
+
+```python
+import numpy as np
+import pandas as pd
+from data_profiling import ProfileReport
+
+df = pd.DataFrame(np.random.rand(100, 5), columns=["a", "b", "c", "d", "e"])
+```
+
+To generate the standard profiling report, merely run:
+
+```python
+profile = ProfileReport(df, title="Profiling Report")
+```
+
+## 📊 Key features
+
+- **Type inference**: automatic detection of columns' data types (*Categorical*, *Numerical*, *Date*, etc.)
+- **Warnings**: A summary of the problems/challenges in the data that you might need to work on (*missing data*, *inaccuracies*, *skewness*, etc.)
+- **Univariate analysis**: including descriptive statistics (mean, median, mode, etc) and informative visualizations such as distribution histograms
+- **Multivariate analysis**: including correlations, a detailed analysis of missing data, duplicate rows, and visual support for variables pairwise interaction
+- **Time-Series**: including different statistical information relative to time dependent data such as auto-correlation and seasonality, along ACF and PACF plots.
+- **Text analysis**: most common categories (uppercase, lowercase, separator), scripts (Latin, Cyrillic) and blocks (ASCII, Cyrilic)
+- **File and Image analysis**: file sizes, creation dates, dimensions, indication of truncated images and existence of EXIF metadata
+- **Compare datasets**: one-line solution to enable a fast and complete report on the comparison of datasets
+- **Flexible output formats**: all analysis can be exported to an HTML report that can be easily shared with different parties, as JSON for an easy integration in automated systems and as a widget in a Jupyter Notebook.
+
+The report contains three additional sections:
+
+- **Overview**: mostly global details about the dataset (number of records, number of variables, overall missigness and duplicates, memory footprint)
+- **Alerts**: a comprehensive and automatic list of potential data quality issues (high correlation, skewness, uniformity, zeros, missing values, constant values, between others)
+- **Reproduction**: technical details about the analysis (time, version and configuration)
+
+### 🎁 Latest features
+
+- Want to scale? Check the latest release with ⭐⚡[Spark support](https://data-profiling.ydata.ai/docs/master/pages/integrations/pypspark.html)! 
+- Looking for how you can do an EDA for Time-Series 🕛 ? Check [this blogpost](https://towardsdatascience.com/how-to-do-an-eda-for-time-series-cbb92b3b1913).
+- You want to compare 2 datasets and get a report? Check [this blogpost](https://medium.com/towards-artificial-intelligence/how-to-compare-2-dataset-with-pandas-profiling-2ae3a9d7695e)
+
+### ✨ Spark
+
+Spark support has been released, but we are always looking for an extra pair of hands 👐.
+[Check current work in progress!](https://github.com/ydataai/data-profiling/projects/3).
+
+## 📝 Use cases
+data-profiling can be used to deliver a variety of different use-case. The documentation includes guides, tips and tricks for tackling them:
+
+| Use case | Description                                                                                 |
+|----------|---------------------------------------------------------------------------------------------|
+| [Comparing datasets](https://docs.profiling.ydata.ai/latest/features/comparing_datasets)                        | Comparing multiple version of the same dataset                                              |
+| [Profiling a Time-Series dataset](https://docs.profiling.ydata.ai/latest/features/time_series_datasets)               | Generating a report for a time-series dataset with a single line of code                    |
+|[Profiling large datasets](https://docs.profiling.ydata.ai/latest/features/big_data)                            | Tips on how to prepare data and configure `data-profiling` for working with large datasets |
+| [Handling sensitive data](https://docs.profiling.ydata.ai/latest/features/sensitive_data)                       | Generating reports which are mindful about sensitive data in the input dataset              |
+| [Dataset metadata and data dictionaries](https://docs.profiling.ydata.ai/latest/features/metadata)               | Complementing the report with dataset details and column-specific data dictionaries         |
+| [Customizing the report's appearance](https://docs.profiling.ydata.ai/latest/features/custom_reports) | Changing the appearance of the report's page and of the contained visualizations            |
+| [Profiling Databases](https://docs.profiling.ydata.ai/latest/features/collaborative_data_profiling) | For a seamless profiling experience in your organization's databases, check [Fabric Data Catalog](https://ydata.ai/products/data_catalog), which allows to consume data from different types of storages such as RDBMs (Azure SQL, PostGreSQL, Oracle, etc.) and object storages (Google Cloud Storage, AWS S3, Snowflake, etc.), among others. |
+### Using inside Jupyter Notebooks
+
+There are two interfaces to consume the report inside a Jupyter notebook: through widgets and through an embedded HTML report.
+
+<img alt="Notebook Widgets" src="https://data-profiling.ydata.ai/docs/master/assets/widgets.gif" width="800" />
+
+The above is achieved by simply displaying the report as a set of widgets. In a Jupyter Notebook, run:
+
+```python
+profile.to_widgets()
+```
+
+The HTML report can be directly embedded in a cell in a similar fashion:
+
+```python
+profile.to_notebook_iframe()
+```
+
+<img alt="HTML" src="https://data-profiling.ydata.ai/docs/master/assets/iframe.gif" width="800" />
+
+### Exporting the report to a file
+
+To generate a HTML report file, save the `ProfileReport` to an object and use the `to_file()` function:
+
+```python
+profile.to_file("your_report.html")
+```
+
+Alternatively, the report's data can be obtained as a JSON file:
+
+```python
+# As a JSON string
+json_data = profile.to_json()
+
+# As a file
+profile.to_file("your_report.json")
+```
+
+### Using in the command line
+
+For standard formatted CSV files (which can be read directly by pandas without additional settings), the `data_profiling` executable can be used in the command line. The example below generates a report named *Example Profiling Report*, using a configuration file called `default.yaml`, in the file `report.html` by processing a `data.csv` dataset.
+
+```sh
+data_profiling --title "Example Profiling Report" --config_file default.yaml data.csv report.html
+```
+
+Additional details on the CLI are available [on the documentation](https://data-profiling.ydata.ai/docs/master/pages/getting_started/quickstart.html#command-line-usage).
+
+## 👀 Examples
+
+The following example reports showcase the potentialities of the package across a wide range of dataset and data types:
+
+* [Census Income](https://data-profiling.ydata.ai/examples/master/census/census_report.html) (US Adult Census data relating income with other demographic properties)
+* [NASA Meteorites](https://data-profiling.ydata.ai/examples/master/meteorites/meteorites_report.html) (comprehensive set of meteorite landing - object properties and locations) [![Open In Colab](https://camo.githubusercontent.com/52feade06f2fecbf006889a904d221e6a730c194/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667)](https://colab.research.google.com/github/ydataai/pandas-profiling/blob/master/examples/meteorites/meteorites_cloud.ipynb) [![Binder](https://camo.githubusercontent.com/483bae47a175c24dfbfc57390edd8b6982ac5fb3/68747470733a2f2f6d7962696e6465722e6f72672f62616467655f6c6f676f2e737667)](https://mybinder.org/v2/gh/ydataai/pandas-profiling/master?filepath=examples%2Fmeteorites%2Fmeteorites%5Fcloud.ipynb)
+* [Titanic](https://data-profiling.ydata.ai/examples/master/titanic/titanic_report.html) (the "Wonderwall" of datasets) [![Open In Colab](https://camo.githubusercontent.com/52feade06f2fecbf006889a904d221e6a730c194/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667)](https://colab.research.google.com/github/ydataai/pandas-profiling/blob/master/examples/titanic/titanic_cloud.ipynb) [![Binder](https://camo.githubusercontent.com/483bae47a175c24dfbfc57390edd8b6982ac5fb3/68747470733a2f2f6d7962696e6465722e6f72672f62616467655f6c6f676f2e737667)](https://mybinder.org/v2/gh/ydataai/pandas-profiling/master?filepath=examples%2Ftitanic%2Ftitanic%5Fcloud.ipynb)
+* [NZA](https://data-profiling.ydata.ai/examples/master/nza/nza_report.html) (open data from the Dutch Healthcare Authority)
+* [Stata Auto](https://data-profiling.ydata.ai/examples/master/stata_auto/stata_auto_report.html) (1978 Automobile data)
+* [Colors](https://data-profiling.ydata.ai/examples/master/colors/colors_report.html) (a simple colors dataset)
+* [Vektis](https://data-profiling.ydata.ai/examples/master/vektis/vektis_report.html) (Vektis Dutch Healthcare data)
+* [UCI Bank Dataset](https://data-profiling.ydata.ai/examples/master/bank_marketing_data/uci_bank_marketing_report.html) (marketing dataset from a bank)
+* [Russian Vocabulary](https://data-profiling.ydata.ai/examples/master/features/russian_vocabulary.html) (100 most common Russian words, showcasing unicode text analysis)
+* [Website Inaccessibility](https://data-profiling.ydata.ai/examples/master/features/website_inaccessibility_report.html) (website accessibility analysis, showcasing support for URL data)
+* [Orange prices](https://data-profiling.ydata.ai/examples/master/features/united_report.html) and 
+* [Coal prices](https://data-profiling.ydata.ai/examples/master/features/flatly_report.html) (simple pricing evolution datasets, showcasing the theming options)
+* [USA Air Quality](https://github.com/ydataai/pandas-profiling/tree/master/examples/usaairquality) (Time-series air quality dataset EDA example)
+* [HCC](https://github.com/ydataai/pandas-profiling/tree/master/examples/hcc) (Open dataset from healthcare, showcasing compare between two sets of data, before and after preprocessing)
+
+## 🛠️ Installation
+Additional details, including information about widget support, are available [on the documentation](https://data-profiling.ydata.ai/docs/master/pages/getting_started/installation.html).
+
+### Using pip
+[![PyPi Downloads](https://pepy.tech/badge/data-profiling)](https://pepy.tech/project/data-profiling)
+[![PyPi Monthly Downloads](https://pepy.tech/badge/pandas-profiling/month)](https://pepy.tech/project/data-profiling/month)
+[![PyPi Version](https://badge.fury.io/py/data-profiling.svg)](https://pypi.org/project/data-profiling/)
+
+You can install using the `pip` package manager by running:
+
+```sh
+pip install -U data-profiling
+```
+
+#### Extras
+
+The package declares "extras", sets of additional dependencies.
+
+* `[notebook]`: support for rendering the report in Jupyter notebook widgets.
+* `[unicode]`: support for more detailed Unicode analysis, at the expense of additional disk space.
+* `[pyspark]`: support for pyspark for big dataset analysis
+
+Install these with e.g.
+
+```sh
+pip install -U data-profiling[notebook,unicode,pyspark]
+```
+
+
+### Using conda
+[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/pandas-profiling.svg)](https://anaconda.org/conda-forge/pandas-profiling)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/pandas-profiling.svg)](https://anaconda.org/conda-forge/pandas-profiling) 
+
+
+You can install using the `conda` package manager by running:
+
+```sh
+conda install -c conda-forge data-profiling
+```
+
+### From source (development)
+
+Download the source code by cloning the repository or click on [Download ZIP](https://github.com/ydataai/pandas-profiling/archive/master.zip) to download the latest stable version.
+
+Install it by navigating to the proper directory and running:
+
+```sh
+pip install -e .
+```
+
+The profiling report is written in HTML and CSS, which means a modern browser is required. 
+
+You need [Python 3](https://python3statement.github.io/) to run the package. Other dependencies can be found in the requirements files:
+
+| Filename | Requirements|
+|----------|-------------|
+| [requirements.txt](https://github.com/ydataai/pandas-profiling/blob/master/requirements.txt) | Package requirements|
+| [requirements-dev.txt](https://github.com/ydataai/pandas-profiling/blob/master/requirements-dev.txt)  |  Requirements for development|
+| [requirements-test.txt](https://github.com/ydataai/pandas-profiling/blob/master/requirements-test.txt) | Requirements for testing|
+| [setup.py](https://github.com/ydataai/pandas-profiling/blob/master/setup.py) | Requirements for widgets etc. |
+
+## 🔗 Integrations
+
+To maximize its usefulness in real world contexts, `data-profiling` has a set of implicit and explicit integrations with a variety of other actors in the Data Science ecosystem: 
+
+| Integration type | Description |
+|---|---|
+| [Other DataFrame libraries](https://docs.profiling.ydata.ai/latest/integrations/other_dataframe_libraries) | How to compute the profiling of data stored in libraries other than pandas |
+| [Great Expectations](https://data-profiling.ydata.ai/docs/master/pages/integrations/great_expectations.html) | Generating [Great Expectations](https://greatexpectations.io) expectations suites directly from a profiling report |
+| [Interactive applications](https://docs.profiling.ydata.ai/latest/integrations/interactive_applications) | Embedding profiling reports in [Streamlit](http://streamlit.io), [Dash](http://dash.plotly.com) or [Panel](https://panel.holoviz.org) applications |
+| [Pipelines](https://data-profiling.ydata.ai/docs/master/pages/integrations/pipelines.html) | Integration with DAG workflow execution tools like [Airflow](https://airflow.apache.org) or [Kedro](https://kedro.org) |
+| [Cloud services](https://data-profiling.ydata.ai/docs/master/pages/integrations/cloud_services.html) | Using `data-profiling` in hosted computation services like [Lambda](https://lambdalabs.com), [Google Cloud](https://github.com/GoogleCloudPlatform/analytics-componentized-patterns/blob/master/retail/propensity-model/bqml/bqml_kfp_retail_propensity_to_purchase.ipynb) or [Kaggle](https://www.kaggle.com/code) |
+| [IDEs](https://data-profiling.ydata.ai/docs/master/pages/integrations/ides.html) | Using `data-profiling` directly from integrated development environments such as [PyCharm](https://www.jetbrains.com/pycharm/) |
+
+## 🙋 Support
+Need help? Want to share a perspective? Report a bug? Ideas for collaborations? Reach out via the following channels:
+
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/pandas-profiling+or+data-profiling): ideal for asking questions on how to use the package
+- [GitHub Issues](https://github.com/ydataai/data-profiling/issues): bugs, proposals for changes, feature requests
+- [Discord](https://tiny.ydata.ai/dcai-data-profiling): ideal for projects discussions, ask questions, collaborations, general chat
+
+> **Need Help?**<br>
+> Get your questions answered with a product owner by [booking a Pawsome chat](https://meetings.hubspot.com/fabiana-clemente)! 🐼
+
+> ❗ Before reporting an issue on GitHub, check out [Common Issues](https://docs.profiling.ydata.ai/latest/support-contribution/common_issues).
+
+## 🤝🏽 Contributing
+Learn how to get involved in the [Contribution Guide](https://data-profiling.ydata.ai/docs/master/pages/support_contrib/contribution_guidelines.html).
+
+A low-threshold place to ask questions or start contributing is the [Data Centric AI Community's Discord](https://tiny.ydata.ai/dcai-data-profiling).
+
+
+A big thank you to all our amazing contributors! 
+
+<a href="https://github.com/ydataai/data-profiling/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ydataai/data-profiling" />
+</a>
+
+Contributors wall made with [contrib.rocks](https://contrib.rocks).