Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 1.65 KB

README.md

File metadata and controls

73 lines (57 loc) · 1.65 KB

exex-cli

CLI for extracting data from Excel documents

PyPI version test codecov


Installation

pip install exex-cli

Usage

Synopsis

python -m exex_cli extract FILENAME --sheet SHEET --range RANGE --format FORMAT 
Parameter Type Default Description
FILENAME (required) string Path to .xlsx file.
[SHEET] (optional) string or int 0 (first sheet) Name or index of sheet
[RANGE] (optional) range all (all values) Range to get values from
[FORMAT] (optional) string text text, table, json, csv

Type of ranges

Type Syntax Example
All values all all
Cell by name [COLUMN_NAME][ROW_NUMBER] A1
Cell by index [COLUMN_INDEX],[ROW_INDEX] 1,1
Cell range [FROM]:[TO] A1:A3
Column [COLUMN_NAME] A
Column range [FROM]:[TO] A:C
Row [ROW_NUMBER] 1
Row range [FROM]:[TO] 1:3

Examples

Get all values as JSON

python -m exex_cli extract sample.xlsx --format json

Get cell range as CSV

python -m exex_cli extract sample.xlsx --range A1:A3 --format csv

Development

Setup

poetry install

Tests (local Python version)

poetry run pytest

Code formatting (black)

poetry run black .