Metadata-Version: 2.4
Name: sumry
Version: 0.3.1
Summary: A data summarization tool for analyzing various file formats
Author: Sparkgeo
License: MIT
Project-URL: Homepage, https://github.com/sparkgeo/sumry
Project-URL: Repository, https://github.com/sparkgeo/sumry
Project-URL: Issues, https://github.com/sparkgeo/sumry/issues
Keywords: data,summary,analysis,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: duckdb>=1.1.2
Requires-Dist: geopandas>=1.0.1
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pyarrow>=17.0.0
Requires-Dist: python-calamine>=0.2.3
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.12.5
Dynamic: license-file

# 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

```bash
pip install sumry
```

## Usage

### Basic Summary

```bash
sumry path/to/your/file.csv
```

### Show Sample Records

```bash
# 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

```bash
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

```bash
# 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.
