Skip to main content

A data summarization tool for analyzing various file formats

Project description

sumry

A fast and user-friendly CLI tool for summarizing various data file formats with rich terminal output.

Features

  • Multiple Format Support: CSV, Excel, GeoJSON, and Shapefiles
  • Rich Terminal Output: Beautiful, colorful summaries using Rich library
  • Quick Insights: Get file statistics, column types, and sample data
  • Geospatial Support: Special handling for GeoJSON and Shapefile formats with geometry information

Installation

pip install sumry

Usage

Basic Summary

sumry path/to/your/file.csv

Show Sample Records

# Show 5 sample records (default)
sumry path/to/your/file.xlsx --show-sample

# Show specific number of samples
sumry path/to/your/file.geojson --sample 10

Verbose Output

sumry path/to/your/file.shp --verbose

Supported File Types

  • CSV (.csv)
  • Excel (.xlsx, .xls)
  • GeoJSON (.geojson, .json)
  • Shapefile (.shp)

Requirements

  • Python >= 3.12
  • Dependencies are automatically installed with the package

Development

# Clone the repository
git clone https://github.com/yourusername/sumry.git
cd sumry

# Install with development dependencies
pip install -e ".[dev]"

# Run tests
pytest

License

MIT License - see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

sumry-0.3.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

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

sumry-0.3.0-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file sumry-0.3.0.tar.gz.

File metadata

  • Download URL: sumry-0.3.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.0

File hashes

Hashes for sumry-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5068650a9bc789e5dcfa1404584e4b55ef7d49004b4d2e628f6da41afd190368
MD5 8de0c939031cbac16639403c2c2fbcb8
BLAKE2b-256 b51636fb918fe291ff084d9456245a04d7bc1e246aae006479b50701acfa4ed1

See more details on using hashes here.

File details

Details for the file sumry-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: sumry-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.0

File hashes

Hashes for sumry-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a573edef72a2bc1ac51befacf3f5313b577706c21cdc2fe6b44e5937bb7170a
MD5 9959099a1dc309441691dc205dab4b36
BLAKE2b-256 0f040a4ed80ebb9db2adbc30bfb9bf34894398249d9de56b690a1b5e9dfc8f22

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