Skip to content

Commit

Permalink
change package name, add dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
DongchunChen committed Jan 23, 2025
1 parent a71f36d commit f6dda55
Show file tree
Hide file tree
Showing 13 changed files with 2,901 additions and 461 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

## v0.1.0 (09/01/2025)

- First release of `dataprofiler`!
- First release of `datpro`!
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ If you are proposing a feature:

## Get Started!

Ready to contribute? Here's how to set up `dataprofiler` for local development.
Ready to contribute? Here's how to set up `datpro` for local development.

1. Download a copy of `dataprofiler` locally.
2. Install `dataprofiler` using `poetry`:
1. Download a copy of `datpro` locally.
2. Install `datpro` using `poetry`:

```console
$ poetry install
Expand All @@ -69,5 +69,5 @@ Before you submit a pull request, check that it meets these guidelines:

## Code of Conduct

Please note that the `dataprofiler` project is released with a
Please note that the `datpro` project is released with a
Code of Conduct. By contributing to this project you agree to abide by its terms.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Dongchun Chen, Ismail (Husain) Bhinderwala, Jingyuan Wang

## dataprofiler
## datpro

The `dataprofiler` package simplifies data profiling by providing essential functions for comprehensive dataset exploration and quality checks. This package offers tools to generate detailed summaries, detect anomalies, and create intuitive visualizations, making it easier to uncover key patterns and insights in your data with minimal effort.
The `datpro` package simplifies data profiling by providing essential functions for comprehensive dataset exploration and quality checks. This package offers tools to generate detailed summaries, detect anomalies, and create intuitive visualizations, making it easier to uncover key patterns and insights in your data with minimal effort.

- `summarize_data()`: Summarizes numeric columns in a given DataFrame by calculating key statistical metrics.This function gives an overview of key statistics of numeric columns. It returns a summary DataFrame containing the minimum, 25th percentile (Q1), median (50th percentile), 75th percentile (Q3), and maximum values for each numeric column.

Expand All @@ -17,7 +17,7 @@ This package provides tools for exploring and cleaning data by summarizing stati
## Installation

```bash
$ pip install dataprofiler
$ pip install datpro
```

## Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = dataprofiler
SPHINXPROJ = datpro
SOURCEDIR = .
BUILDDIR = _build

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# -- Project information -----------------------------------------------------

project = u"dataprofiler"
project = u"datpro"
copyright = u"2025, DongchunChen"
author = u"DongchunChen"

Expand Down
16 changes: 8 additions & 8 deletions docs/example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Example usage\n",
"\n",
"To use `dataprofiler` in a project:"
],
"metadata": {}
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import dataprofiler\n",
"import datpro\n",
"\n",
"print(dataprofiler.__version__)"
],
"outputs": [],
"metadata": {}
"print(datpro.__version__)"
]
}
],
"metadata": {
Expand All @@ -42,4 +42,4 @@
},
"nbformat": 4,
"nbformat_minor": 4
}
}
Loading

0 comments on commit f6dda55

Please sign in to comment.