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.1.0.tar.gz (9.8 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.1.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sumry-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d541a4513747fc19f45ad874c1091ade866df52a9aa0ed121aebdab5f85bd858
MD5 70bb3fbfa473586db4e03e505db8ff18
BLAKE2b-256 1f3573d4150bc42a4c463e6c71ac92dd53aa9ef60deabc1dcf1c0d6e86e99af1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sumry-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca4dc49b34de870002f4b77d3408811eeea3834228d7bf55205a066567ac655e
MD5 3177eb4aaa750417d42f5c53ca7354e7
BLAKE2b-256 4c9fea94a63e89819b0fe5ac44980466d8aec5df907212a68db578d3ca47ab70

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