Metadata-Version: 2.4
Name: ydata_profile
Version: 1.0.5
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<2,>=1.5.0
Requires-Dist: fg-data-profiling<5.0,>=4.19.1
Requires-Dist: midir>=1.2.1
Requires-Dist: pandas<3.0,>=2.3.3
Requires-Dist: setuptools<82,>=75
Requires-Dist: streamlit<2.0,>=1.61.1
Requires-Dist: twine<8,>=7.0.0
Dynamic: license-file

# `ydata_profile`

## Run the streamlit app

After installing the package, launch the app from any Unix shell with:

```
$ datashow
```

You can also pass a CSV file directly. The app will load it on startup and autodetect the delimiter, falling back to `,` when detection is not possible.

```
$ datashow path/to/file.csv
```

Uploaded files in the browser still work and override the CSV passed from the command line.

The Streamlit sidebar includes a `Quit datashow` button to close the session and stop the server.

From a clone of this repository, you can still run the app directly:

```
$ 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()                  # opens the Streamlit app
run_ydata_profile("path/to/file.csv") # opens the app with a CSV loaded
```

#### 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`
