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.4.0.tar.gz (13.2 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.4.0-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sumry-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f8638a66ff672cfe5c0d7001069072a481ca0ca9f920dd26a114c7972e615f16
MD5 5e5da92cdf52cbcc54089a1e17eefed7
BLAKE2b-256 988c8d582f2d6b366357e78c976e5d551d1e21a6589eb01d66a4cb237cfc08d9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sumry-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd9a8a06df30cae267870c12223b2f22bc6fe05e3fb2d22cb11cfb8975dde2c3
MD5 63549b0d67d7ca99a57385982c8f4299
BLAKE2b-256 5de7b2216d922a677de80c50a9eb73fb2ecc96cf96b9accec77368923419707a

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