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.1.tar.gz (10.6 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.1-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sumry-0.3.1.tar.gz
Algorithm Hash digest
SHA256 7511307650b3c28bc4d5ef7cc9434bbacfbc6b9581c9e13231a3496ea73c15e4
MD5 6cca0a1676d0b5201c3575f9b9f0bb49
BLAKE2b-256 6437072126411d2e353032745e9eb4a798117cdfce8d257bfd863c196b1720f6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sumry-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0ab975a988de566c1876f81cf79837316ff02b4951d78cde58ba42db082ef330
MD5 29811441144dd690006f3dd7201a6d8e
BLAKE2b-256 f4fba647909ea27a82d73469b76197880ec82631bee98788b1f576c9aa9f7b05

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