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.2.0.tar.gz
(10.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
sumry-0.2.0-py3-none-any.whl
(11.1 kB
view details)
File details
Details for the file sumry-0.2.0.tar.gz.
File metadata
- Download URL: sumry-0.2.0.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cbeb664af7e25ebc4196b0fe885e09724d2477b66495f6a89b33a8f369f699d5
|
|
| MD5 |
a1e06501cd8f1ea282751896b5788bc7
|
|
| BLAKE2b-256 |
89f8e3b3fb9dc3224782c7bae03642081623a0ed42cdcc62e83faff6f5239e58
|
File details
Details for the file sumry-0.2.0-py3-none-any.whl.
File metadata
- Download URL: sumry-0.2.0-py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e017d4a81fc5352ed51a9efd3043a5525ea32358c3412adf3ffcb0538613a78a
|
|
| MD5 |
8c28e3187469572677c58447bedba176
|
|
| BLAKE2b-256 |
3240981da6cfa11f39d194fb2a08c2973517067a68fecc0f228109ac89af8002
|