Preserve good formatting when exporting to *.xlsx, *.yaml and *.json and when updating data.
Project description
pyexcel-export - Keep optimal formatting when exported to xlsx format
pyexcel-export is a wrapper around pyexcel, pyexcel-xlsx and openpyxl to read the formatting (stylesheets) and update the pre-existing file without destroying the stylesheets.
pyexcel-export also introduces two new exporting format, *.yaml
and *.pyexcel.json
which is based on NoIndentEncoder. This allows you to edit the spreadsheet in you favorite text editor, without being frustrated by automatically collapsed cells in Excel.
Known constraints
The "stylesheets" exported from Excel is in a very long base64 encoded format when exported to *.json
or *.pyexcel.json
, so exporting such to *.json
is disabled by default.
As stylesheets copying works by openpyxl.worksheet.copier.WorksheetCopy
, it may work only on values, styles, dimensions and merged cells, but charts might not be supported.
Installation
You can install pyexcel-export via pip:
$ pip install pyexcel-export
or clone it and install it.
Usage
For more documentation, see https://github.com/patarapolw/pyexcel-export/tree/master/docs
Read *.pyexcel.json
>>> from pyexcel_export import get_data
>>> from collections import OrderedDict
>>> data, meta = get_data('test.yaml') # *.pyexcel.json is also possible.
>>> data
OrderedDict([('test', [['id', 'English', 'Pinyin', 'Hanzi', 'Audio', 'Tags'], [1419644212689, 'Hello!', 'Nǐ hǎo!', '你好!', '[sound:tmp1cctcn.mp3]', ''], [1419644212690, 'What are you saying?', 'Nǐ shuō shénme?', '你说什么?', '[sound:tmp4tzxbu.mp3]', ''], [1419644212691, 'What did you do?', 'nǐ zuò le shénme ?', '你做了什么?', '[sound:333012.mp3]', '']])])
>>> meta
Meta([
('created', '2018-07-15T05:32:43.976194'),
('modified', '2018-07-16T07:31:26.232350'),
('has_header', True),
('freeze_header', True),
('col_width_fit_param_keys', True),
('col_width_fit_ids', True),
('bool_as_string', True),
('allow_table_hiding', True),
('_styles', <_io.BytesIO object at 0x1065dff10>)
])
>>> meta.matrix
[('created', '2018-07-15T05:32:43.976194'), ('modified', '2018-07-15T05:32:52.248192'), ('has_header', True), ('freeze_header', True), ('col_width_fit_param_keys', True), ('col_width_fit_ids', True), ('allow_hidden_tables', True), ('_styles', {"<class '_io.BytesIO'>": <_io.BytesIO object at 0x1103d9048>})]
>>> meta.excel_matrix
[('created', '2018-07-15T05:32:43.976194'), ('modified', '2018-07-15T05:32:52.248192'), ('has_header', {"<class 'bool'>": True}), ('freeze_header', {"<class 'bool'>": True}), ('col_width_fit_param_keys', {"<class 'bool'>": True}), ('col_width_fit_ids', {"<class 'bool'>": True}), ('allow_hidden_tables', {"<class 'bool'>": True}), ('_styles', {"<class '_io.BytesIO'>": <_io.BytesIO object at 0x10b56b048>})]
Exporting stylesheets
>>> from pyexcel_export import get_meta
>>> get_meta()
Meta([
('created', '2018-07-15T05:32:43.976194'),
('has_header', True),
('freeze_header', True),
('col_width_fit_param_keys', True),
('col_width_fit_ids', True),
('bool_as_string', True),
('allow_table_hiding', True)
])
>>> get_meta('test.xlsx')
Meta([
('created', '2018-07-15T05:32:43.976194'),
('modified', '2018-07-16T07:31:26.232350'),
('has_header', True),
('freeze_header', True),
('col_width_fit_param_keys', True),
('col_width_fit_ids', True),
('bool_as_string', True),
('allow_table_hiding', True),
('_styles', <_io.BytesIO object at 0x1065dff10>)
])
Saving files, while preserving the formatting.
>>> from pyexcel_export import get_meta, save_data
>>> from collections import OrderedDict
>>> meta = get_meta('test.xlsx')
>>> data = OrderedDict()
>>> data.update({"Sheet 1": [["header A", "header B", "header C"], [1, 2, 3]]})
>>> save_data("your_file.xlsx", data, meta=meta)
Of course, you can use the ExcelLoader class directly
>>> from pyexcel_export import ExcelLoader
>>> loader = ExcelLoader("test.xlsx")
>>> loader.save("test.xlsx")
*.yaml format
_meta:
- [created, '2018-07-15T05:32:43.976194']
- [modified, '2018-07-16T07:45:53.534165']
- [has_header, true]
- [freeze_header, true]
- [col_width_fit_param_keys, true]
- [col_width_fit_ids, true]
- [bool_as_string, true]
- [allow_table_hiding, true]
test:
- [id, English, Pinyin, Hanzi, Audio, Tags]
- [1419644212689, Hello!, Nǐ hǎo!, 你好!, '[sound:tmp1cctcn.mp3]', '']
- [1419644212690, 'What are you saying?', 'Nǐ shuō shénme?', 你说什么?, '[sound:tmp4tzxbu.mp3]',
'']
- [1419644212691, 'What did you do?', 'nǐ zuò le shénme ?', 你做了什么?, '[sound:333012.mp3]',
'']
*.pyexcel.json format
{
"_meta": [
["\"created\"", "\"2018-07-12T15:21:25.777499\""],
["\"modified\"", "\"2018-07-15T06:59:22.707162\""],
["\"has_header\"", "true"],
["\"freeze_header\"", "true"],
["\"col_width_fit_param_keys\"", "true"],
["\"col_width_fit_ids\"", "true"]
],
"test": [
["\"id\"", "\"English\"", "\"Pinyin\"", "\"Hanzi\"", "\"Audio\"", "\"Tags\""],
["1419644212689", "\"Hello!\"", "\"Nǐ hǎo!\"", "\"你好!\"", "\"[sound:tmp1cctcn.mp3]\"", "\"\""],
["1419644212690", "\"What are you saying?\"", "\"Nǐ shuō shénme?\"", "\"你说什么?\"", "\"[sound:tmp4tzxbu.mp3]\"", "\"\""],
["1419644212691", "\"What did you do?\"", "\"nǐ zuò le shénme ?\"", "\"你做了什么?\"", "\"[sound:333012.mp3]\"", "\"\""]
]
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyexcel_export-0.2.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89357249007e592f6a3c3445b314331b3628e82a3a5ce8ffaa4c5823dc41096b |
|
MD5 | ee417b4e80dea30822ea1d88d8e57404 |
|
BLAKE2b-256 | eb1fd52a84fb45d59309d12c6085ce1891121dfe934124ff81ca3bfc5e25bb89 |