Skip to main content

Small CSV utilities: row deduplication, classification, row filtering, and CLI helpers.

Project description

PyPI version Supported Python versions License Documentation

Small, focused CSV utilities for common data wrangling tasks.

csvsmith provides a handful of practical tools for working with CSV files, including cleaning numeric values, filtering rows, deduplicating records, classifying files, converting Excel spreadsheets to CSV, moving files by suffix, and finding matches inside CSV content.

Documentation

Read the full documentation at:

https://csvsmith.readthedocs.io/en/latest/

Features

  • Clean numeric strings into normalized values

  • Filter CSV rows by substring matching

  • Deduplicate row data and generate reports

  • Classify CSV files into folders based on headers/signatures

  • Convert Excel workbooks to CSV

  • Move files by suffix

  • Find matching values inside CSV files

  • Use the tools either from Python or from the command line

Installation

Install the package in your environment as usual for your project setup.

Example:

pip install csvsmith

If you are developing locally, install it in editable mode from the project root:

pip install -e .

Quick start

You can use the library from Python:

from csvsmith.utils.clean_numeric import clean_currency_numeric

print(clean_currency_numeric("$1,234.56"))

For command-line usage, use single quotes around values containing $:

csvsmith --help

Command-line usage

The package provides a CLI with several subcommands.

Clean numeric values:

csvsmith clean-numeric "1,234.56" --sep "," --decimal "."

Clean currency-prefixed numeric values:

csvsmith clean-currency-numeric '$1,234.56' --sep "," --decimal "."

Filter rows in a CSV:

csvsmith drop-rows input.csv notes spam --case-insensitive --drop-header

Deduplicate rows:

csvsmith dedupe input.csv -o out.csv --subset id --keep first

Classify CSV files:

csvsmith classify src_dir dst_dir --mode relaxed --match subset --auto --dry-run

Convert Excel to CSV:

csvsmith excel2csv input.xlsx

Move files by suffix:

csvsmith move-files src_dir dst_dir --suffixes .csv,.pdf

Find matches in a CSV:

csvsmith find-matches input.csv target --ignore-case --ignore-whitespace

Find matches in a CSV

find_matches_in_csv searches a CSV file for a target value and returns match records containing coordinates and row context information.

Python API:

from csvsmith import find_matches_in_csv

results = find_matches_in_csv("input.csv", "target")

CLI:

csvsmith find-matches input.csv target

Options:

  • --ignore-case: ignore case while matching

  • --ignore-whitespace: ignore whitespace while matching

  • --no-nfkc: disable NFKC normalization

If matches are found, the CLI prints formatted JSON. If no matches are found, it prints a simple message.

Other Python APIs

The package also exposes a few other helper functions and classes from its top-level API.

Numeric and row tools:

from csvsmith import (
    clean_numeric,
    count_duplicates_sorted,
    add_row_digest,
    find_duplicate_rows,
    dedupe_with_report,
    read_csv_rows,
    write_csv_rows,
)

CSV classification and filtering:

from csvsmith import CSVClassifier, DropRowsBySubstring, CSVCleaner

File and conversion helpers:

from csvsmith import excel_to_csv, move_by_suffix

String comparison utilities:

from csvsmith import StringDistance, Relation, Result, analyze_pair

Project structure

The code is organized into two main areas:

  • csvsmith.tools for higher-level CSV workflows

  • csvsmith.utils for reusable utility helpers

Testing

Run the test suite with your preferred Python test runner.

Example:

pytest

License

See the project license for details.

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

csvsmith-0.7.3.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

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

csvsmith-0.7.3-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file csvsmith-0.7.3.tar.gz.

File metadata

  • Download URL: csvsmith-0.7.3.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for csvsmith-0.7.3.tar.gz
Algorithm Hash digest
SHA256 96da4ff01f965e18eb724b24be5bc61a1467ce34fcc5a86289a63efb101a6092
MD5 5164bf0e85f53a65f6041b06759427df
BLAKE2b-256 39aa951efb7827a811a2dfbebfdff015e812b351a328cad0f5812703b1e710a9

See more details on using hashes here.

File details

Details for the file csvsmith-0.7.3-py3-none-any.whl.

File metadata

  • Download URL: csvsmith-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 22.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for csvsmith-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a6f3c285c8c665cf8b1e54a31da57cdb85149338c5178488b4ed2056179ddb0a
MD5 9596f9c8d23f4d4b8d0acb021f394463
BLAKE2b-256 09bec6fdafd5bf278461bd479dfa41cfd527bf9d3d1880214076186f1319a4ec

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