Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anisotropi4/spreadsheet
Scripts to dump common spreadsheet file format tabs to TSV or CSV files
https://github.com/anisotropi4/spreadsheet
Last synced: 3 days ago
JSON representation
Scripts to dump common spreadsheet file format tabs to TSV or CSV files
- Host: GitHub
- URL: https://github.com/anisotropi4/spreadsheet
- Owner: anisotropi4
- License: mit
- Created: 2019-12-17T22:06:38.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-17T23:27:38.000Z (about 5 years ago)
- Last Synced: 2024-11-05T05:26:10.256Z (about 2 months ago)
- Language: Python
- Size: 89.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dump `ODS` spreadsheet content with `ods2tsv.py` and, `XLS` and `XLSX` with `xl2tsv.py`
The `ods2tsv.py` script dumps the content of `ods` files to a `[tabname].tsv` diles in the (default) `output` directory. The `xl2tsv.py` script dumps the content of `xls` and `xlsx` files to a `[tabname].tsv` in the (default) `output` directory.
Command line parameters:
+ ```--tabnames``` to dump the names of the tabs in the file(s) and stop
+ ```--path``` (optional) set the output directory path (default) output
+ ```--tab``` (optional) set the name of the tab to process
+ ```--csv``` (optional) output in CSV rather than TSV format
+ ```--sourcename``` (optional) append file name to the outpuf file
If not present in the current directory, the `ods2tsv.py` script creates the (default) `output` directory
## Dependencies
The `ods2tsv.py` is a simple wrapper script based on the python3 and the [xlrd](https://pypi.org/project/xlrd), [odfpy](https://https://github.com/eea/odfpy) and [pandas](https://pandas.pydata.org) libraries.
The `xl2tsv.py` is a simple wrapper script based on the python3 and the [xlrd](https://pypi.org/project/xlrd) and [pandas](https://pandas.pydata.org) libraries.
## Set up a virtual python environment
It is recommended that python library dependencies are managed via a `virtual environment`. This is configured and activated as follows:
```
$ virtualenv venv
$ source venv/bin/activate
```
In the virtual environment use `pip` to install the `pandas` and `odfpy` libraries:
```
(venv) $ ./venv/bin/pip install pandas odfpy
```
The `ods2tsv.py` library dependencies are then met:
```
(venv) $ ./ods2tsv.py -h
usage: ods2tsv.py [-h] [--tabnames | --tab TAB]
[--path PATH | --csv | --stdout] [--sourcename]
[inputfiles [inputfiles ...]]
Dump ods files tab(s) to .tsv files, to the (default output) path
positional arguments:
inputfiles name of ods-file to process
optional arguments:
-h, --help show this help message and exit
--tabnames dump name of tabs
--tab TAB name of tab to process
--path PATH output directory file
--csv csv file output
--stdout dump a tab to stdout
--sourcename prepend filename to output tab file
```
The `virtual environment` is deactivated as follows:
```
(venv)$ deactivate
```
## `ODS` file-format usage examples
To run following examples download the `bus0112.ods` and `bus0113.ods` [bus passenger journey statistics](https://www.gov.uk/government/statistical-data-sets/bus01-local-bus-passenger-journeys) files.
### Basic usage
Dump the `BUS0112` tab from the `bus0112.ods` file in a `.tsv` format in the `output` directory:
```
$ ./ods2tsv.py bus0112.ods
$ ls output
BUS0112.tsv
```
### All tabs in a file
Dump the names of the tabs from the `bus0112.ods` file:
```
$ ./ods2tsv.py --tabnames
BUS0112
```
### One tab into a given directory
Dump the `BUS0112` tab data into the `bus` directory:
```
$ ./ods2tsv.py --tab BUS0112 --path bus bus0112.ods
$ ls bus
BUS0112.tsv
```
### All tabs from multiple-files into multiple `.tsv` files and pre-pend filename
Dump all the tab data from the `bus0112.ods` and `bus0113.ods` files into the `output` directory with filenames `:.tsv`:
```
$ ./ods2tsv.py --sourcename bus0112.ods bus0113.ods
$ ls output
bus0112:BUS0112.tsv
bus0113:BUS0113.tsv
```
### Dump a named-tab into a `.csv` files
Dump the `BUS0112` tab data from the `bus0112.ods` file into the `output` directory with filenames `BUS0112.csv`:
```
$ ./ods2tsv.py --csv --tab BUS0112 bus0112.ods
$ ls output
BUS0112.csv
```
### `XLS` and `XLSX` file usage examples
To run following examples download DfT connectivity statistics [connectivity-statistics-destination-lists.xls](https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/435905/connectivity-statistics-destination-lists.xls) and the historic US gun crime (`US gun crime.xlsx`) statistic file.
### Basic usage
Dump the `Airports`, `Junctions`, `RailStations` and `VariableDefinitions` tab data from the `connectivity-statistics-destination-lists.xls` into `.tsv` files in the `output` directory:
```
$ ./xl2tsv.py connectivity-statistics-destination-lists.xls
$ ls output
Airports.tsv Junctions.tsv RailStations.tsv VariableDefinitions.tsv
```
### All tabs in a file
Dump the names of the tabs from the `connectivity-statistics-destination-lists.xls` file:
```
$ ./xl2tsv.py --tabnames connectivity-statistics-destination-lists.xls
VariableDefinitions Airports RailStations Junctions
```
### One tab into a given directory
Dump the `Junctions` tab data into the `connectivity` directory:
```
$ ./xl2tsv.py --tab Junctions --path connectivity connectivity-statistics-destination-lists.xls
$ ls connectivity
Junctions.tsv
```
### All tabs from multiple-files into multiple `.tsv` files
Dump all the tab data from the `connectivity-statistics.xls` and `US gun crime.xlsx` files into the `output` directory with filenames `:.tsv`:
```
$ ./xl2tsv.py --sourcefile connectivity-statistics.xls 'US gun crime.xlsx'
$ ls output
connectivity-statistics:Airports.tsv
connectivity-statistics:Junctions.tsv
connectivity-statistics:RailStations.tsv
connectivity-statistics:VariableDefinitions.tsv
'US gun crime:2010 SUMMARY.tsv'
'US gun crime:2011 MURDER.tsv'
'US gun crime:ASSAULT 2009.tsv'
'US gun crime:ASSAULT 2010.tsv'
'US gun crime:ASSAULT 2011.tsv'
'US gun crime:CHART TRENDS.tsv'
'US gun crime:MURDER 2009.tsv'
'US gun crime:MURDER 2010.tsv'
'US gun crime:MURDER TRENDS.tsv'
'US gun crime:POPULATION DATA.tsv'
'US gun crime:ROBBERY 2009.tsv'
'US gun crime:ROBBERY 2010.tsv'
'US gun crime:ROBBERY 2011.tsv'
'US gun crime:SUMMARY 2011.tsv'
```