Merge pull request #23 from ray310/003

Version 0.0.3

Author: ray310

.github/workflows/format_lint_old.yml .github/workflows/format_lint.yml.github/workflows/format_lint_old.yml renamed to .github/workflows/format_lint.yml

@@ -7,27 +7,26 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: psf/black@stable
         with:
           options: "--check --verbose"
   pylint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          pip install pylint
+          python -m pip install .
+          python -m pip install .[test]
       - name: Linting code with pylint
         run: |
           pylint $(git ls-files '*.py')
-

.github/workflows/pytest_old.yml .github/workflows/pytest.yml.github/workflows/pytest_old.yml renamed to .github/workflows/pytest.yml

@@ -9,23 +9,22 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         lfs: true
     - name: Checkout Git-LFS objects
       run: git lfs checkout
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         python -m pip install .
+        python -m pip install .[test]
     - name: Test with pytest
       run: |
         pytest

.gitignore

@@ -9,8 +9,12 @@
 
 # folders
 .coverage
+.idea
 data
 dev
 dist
 htmlcov
 __pycache__
+
+# files
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    -   id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-merge-conflict
+    -   id: detect-private-key
+    -   id: mixed-line-ending
+-   repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.4.2
+    hooks:
+    -   id: black
+        language_version: python3.12
+        args: [--check, --verbose]
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+    -   id: codespell
+-   repo: local
+    hooks:
+    -   id: pylint
+        name: pylint
+        entry: pylint
+        language: python
+        types: [python]
+        require_serial: true
+        stages: [pre-commit, pre-push]
+        args: ["--verbose"]

CHANGELOG.md

@@ -4,6 +4,14 @@
 ### Added
 - Improved project documentation
 ____
+## 0.0.3 - Soon to be released
+### Added
+- Update for Python 3.12
+- Switch project build to pyproject.toml [gh-18](https://github.com/ray310/Panda-Helper/issues/18)
+- Simplify import: `import pandahelper` now imports `DataFrameProfile`, `SeriesProfile`, `frequency_table`, and `distribution_stats` [gh-17](https://github.com/ray310/Panda-Helper/issues/17)
+- Improved `SeriesProfile` to better handle different data types. [gh-19](https://github.com/ray310/Panda-Helper/issues/19)
+- Removed excess trailing whitespace on reports [gh-21](https://github.com/ray310/Panda-Helper/issues/21)
+____
 ## 0.0.2 - 2022-06-07
 ### Added
 - Added improved type-checking for functions and profile classes

MANIFEST.in

@@ -1,2 +1 @@
 recursive-include tests *.py *.txt *csv
-include requirements.txt

README.md

@@ -1,13 +1,15 @@
+![PyPI - Version](https://img.shields.io/pypi/v/panda-helper)
+[![Download Stats](https://img.shields.io/pypi/dm/panda-helper)](https://pypistats.org/packages/panda-helper)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/panda-helper)
-![Tests Status](https://github.com/ray310/Panda-Helper/actions/workflows/pytest_old.yml/badge.svg)
-![Lint/Format Status](https://github.com/ray310/Panda-Helper/actions/workflows/format_lint_old.yml/badge.svg)
+![Tests Status](https://github.com/ray310/Panda-Helper/actions/workflows/pytest.yml/badge.svg)
+![Lint/Format Status](https://github.com/ray310/Panda-Helper/actions/workflows/format_lint.yml/badge.svg)
 
 # Panda-Helper: Quickly and easily inspect data
-Panda-Helper is a simple data-profiling utility for Pandas DataFrames and Series
+Panda-Helper is a simple data-profiling utility for Pandas' DataFrames and Series.
 
-Assess data quality and usefulness with minimal effort
+Assess data quality and usefulness with minimal effort.
 
-Quickly perform initial data exploration, _so you can move on to more in-depth analysis_
+Quickly perform initial data exploration, _so you can move on to more in-depth analysis_.
 
 -----
 ### DataFrame profiles:
@@ -23,7 +25,7 @@ _Vehicles passing through toll stations_
     -------------------------  ------------
     DF Shape                   (1586280, 6)
     Duplicated Rows             2184
-    
+
     Column Name                 Data Type
     --------------------------  -----------
     Plaza ID                    int64
@@ -32,7 +34,7 @@ _Vehicles passing through toll stations_
     Direction                   object
     # Vehicles - ETC (E-ZPass)  int64
     # Vehicles - Cash/VToll     int64
-    
+
     Summary of Nulls Per Row
     --------------------------  -----------
     count                       1.58628e+06
@@ -53,12 +55,12 @@ _Vehicles passing through toll stations_
 
 -----
 ### Series profiles report the:
-- Series data type 
+- Series data type
 - Count of non-null values in the series
 - Number of unique values
 - Count of null values
 - Counts and frequency of the most and least common values
-- Distribution statistics for numeric data
+- Distribution statistics for numeric-like data
 
 __Sample profile of categorical data__<br>
 _Direction vehicles are traveling_
@@ -69,7 +71,7 @@ _Direction vehicles are traveling_
     Count             1586280
     Unique Values     2
     Null Values       0
-    
+
     Value      Count  % of total
     -------  -------  ------------
     I         814100  51.32%
@@ -84,7 +86,7 @@ _Hourly vehicle counts at tolling points_
     Count                              1586280
     Unique Values                      8987
     Null Values                        0
-    
+
       Value    Count  % of total
     -------  -------  ------------
           0     3137  0.20%
@@ -112,7 +114,7 @@ _Hourly vehicle counts at tolling points_
        8876        1  0.00%
        8261        1  0.00%
        8694        1  0.00%
-    
+
     Statistic                            Value
     -------------------------  ---------------
     count                          1.58628e+06
@@ -141,7 +143,7 @@ __Profiling a DataFrame__<br>
 Create the DataFrameProfile and then display it or save the profile.
 ```python
 import pandas as pd
-import pandahelper.reports as ph
+import pandahelper as ph
 
 data = {
     "user_id": [1, 2, 3, 4, 4],
@@ -158,14 +160,14 @@ df_profile
     -------------------------  ------
     DF Shape                   (5, 4)
     Obviously Duplicated Rows  1
-    
+
     Column Name    Data Type
     -------------  -----------
     user_id        int64
     transaction    object
     amount         float64
     survey         object
-    
+
     Summary of Nulls Per Row
     --------------------------  --------
     count                       5
@@ -183,7 +185,7 @@ df_profile
     median absolute deviation   1
     standard deviation          0.83666
     skew                        0.512241
-    
+
 ```python
 df_profile.save_report("df_profile.txt")
 ```
@@ -200,13 +202,13 @@ series_profile
     Count          4
     Unique Values  3
     Null Values    1
-    
+
       Value    Count  % of total
     -------  -------  ------------
       85.12        2  50.00%
      100           1  25.00%
     1400           1  25.00%
-    
+
     Statistic                       Value
     -------------------------  ----------
     count                         4
@@ -224,7 +226,7 @@ series_profile
     median absolute deviation     7.44
     standard deviation          654.998
     skew                          1.99931
-    
+
 ```python
 series_profile.save_report("amount_profile.txt")
 ```

conda_environment_dev.yaml

@@ -3,19 +3,22 @@ channels:
     - defaults
     - conda-forge
 dependencies:
-    - python=3.9
-    - black
-    - build
-    - coverage
-    - jupyter
-    - pandas
-    - pip
-    - pydocstyle
-    - pylint
-    - pytest
-    - notebook
-    - scipy
-    - sphinx
-    - twine
+    - python=3.12
+    - black=24.4.2
+    - build=0.7.0
+    - codespell=0.0.0
+    - coverage=7.2.2
+    - jupyter=1.0.0
+    - notebook=7.0.8
+    - numpy=1.26.4
+    - pandas=2.2.2
+    - pip=24.0
+    - pre-commit=3.4.0
+    - pydocstyle=6.3.0
+    - pylint=3.2.2
+    - pytest=7.4.4
+    - scipy=1.13.1
+    - sphinx=7.3.7
+    - twine=4.0.2
     - pip:
-        - tabulate
+        - tabulate=0.9.0

pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "panda-helper"
+version = "0.0.3"
+dependencies = [
+  "pandas>=2.0",
+  "scipy>=1.11",
+  "tabulate",
+]
+requires-python = ">=3.9"
+authors = [
+    {name = "Ray310", email = "ray310@pm.me"},
+]
+readme = "README.md"
+description = "Data profiler for Pandas"
+keywords = ["data-profiling", "data-profiling-utility", "data-analysis"]
+license = {file = "LICENSE"}
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+]
+
+[project.urls]
+Homepage = "https://ray310.github.io/Panda-Helper/"
+Repository = "https://github.com/ray310/Panda-Helper"
+Issues = "https://github.com/ray310/Panda-Helper/issues"
+
+[project.optional-dependencies]
+test = ["pytest>=7.4", "pylint>=3.0"]