Skip to main content

A tool to inspect your incoming dataframes and excel files.

Project description

df-this


Every enjoyed ever-changing data incoming? Not knowing what to expect in Excel files coming from 'trusted' sources? Rumours talking about distinct columns or no nan/null/empty values?

Welcome to your solution: df-this


What are you talking about exactly?

df-this is a library with 3 small functions to quickly check your dataframe in your code or any incoming Excel file using CLI commands. It will break down your dataframe and give you basic insights about what to expect from your data. But before we come to the main idea of this library, let me explain to you the 2 minor add-on functions first!

df_stats() | CLI: df-this --stat input.xlsx output_name

This will simply check for numeric columns and give you a basic statistical summary for each column:

  • Minimum value
  • Maximum value
  • Mean (average)
  • Median
  • Sample standard deviation (ddof=1)
  • Population standard deviation (ddof=0)

When using the CLI command it will save the created summary as an Excel file with output_name as path (if not given an output_name it will save it under a default name). The python function simply returns the summary as dataframe.

df_nullique() | CLI: df-this --null input.xlsx output_name

Basically profiles the uniqueness, distinctness, and missingness of each column in the dataframe. For each column:

  • Determines if all values are unique
  • Counts the number of distinct values, treating null and empty strings as distinct categories
  • Classifies the type of missing data
    • "null" if only NaN/None values are present
    • "empty" if only empty strings are present
    • "empty/null" if both are found
    • "filled" if neither are present

When using the CLI command it will save the created summary as an Excel file with output_name as path (if not given an output_name it will save it under a default name). The python function simply returns the summary as dataframe.

df_desc() | CLI: df-this --desc input.xlsx output_name

This function is the main reason this library exists. It analyzes the character composition of each column in a dataframe. For every column, it scans all non-null cell values (after converting to string) and identifies which types of characters appear, including:

  • Numeric digits
  • Lowercase letters
  • Uppercase letters
  • Whitespace characters
  • Brackets and quotation marks
  • Punctuation symbols
  • Mathematical/logic operators
  • Other ASCII characters
  • Non-ASCII characters

When using the CLI command it will save the created summary as an Excel file with output_name as path (if not given an output_name it will save it under a default name). The python function simply returns the summary as dataframe.


The full CLI command:

CLI: df-this --all input.xlsx output_name

This will take the input.xlsx file, create 3 additional sheets for each function and save the original Excel sheet with the 3 additional sheets under the output_name (if not given an output_name it will save it under a default name). THIS IS NOT AVAILABLE AS A PYTHON FUNCTION.


Published under Apache 2.0 - (See LICENSE file)

If you have any recommendations/wishes, let me know.


Version 0.1.0: First release of this library. Contains 3 functions and CLI support for Excel files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

df_this-0.1.2.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

df_this-0.1.2-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file df_this-0.1.2.tar.gz.

File metadata

  • Download URL: df_this-0.1.2.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for df_this-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2bf045ccf839115d5e7a280dd3e6a0c5c45001ea00c6e42fcf88fcf6011ebf3b
MD5 e47ab841f07276d9003b827d18323044
BLAKE2b-256 5dbacd61a017e6608f954ace827e3506ae29e51fba626475828ddc0caa8a2d62

See more details on using hashes here.

File details

Details for the file df_this-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: df_this-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for df_this-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9303b893f447cda7b3df32fe6c326b3f1e82c9d90aa896608344a0c52f6e435e
MD5 c68425fff03b426659944dda333a3935
BLAKE2b-256 6d2c8bd7c425ad04303280588634fd1a610abce430b5ec998b5b629987ee92c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page