Metadata-Version: 2.4
Name: ydata_profile
Version: 1.0.4
Author-email: Jordi Carrera Ventura <jordi.carrera.ventura@gmail.com>
Project-URL: GitHub repository, https://github.com/JordiCarreraVentura/ydata_profile
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: <3.12,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: build==1.2.2.post1
Requires-Dist: midir
Requires-Dist: pandas==2.2.3
Requires-Dist: streamlit>=1.43.2
Requires-Dist: streamlit-ydata-profiling>=0.2.1
Requires-Dist: twine==5.1.1
Requires-Dist: ydata-profiling>=4.18.0
Dynamic: license-file

# `ydata` profile

## Run the streamlit app

```
$ cd ydata_profile
$ streamlit run src/ydata_profile/streamlit_app.py
```

## Instructions for building the package


### Usage

```
from ydata_profile import run_ydata_profile
run_ydata_profile()     # this will open the streamlit app on the browser
```

#### Update dependencies

If any dependencies are required, edit the `pyproject.toml` file, `[project]` field, and add a `dependencies` key with a `List[str]` value, where each string is a `pip`-readable dependency.

#### Upload

1. Building the package before uploading:

   `$ python -m build   # (from 'ydata_profile')`.

2. Upload the package to pypi:

   `$ python -m twine upload --repository pypi dist/LAST_VERSION`

#### Test

3. Install the package from pypi
    `python -m pip install --index-url https://pypi.org`
