Tree @69aa864 (Download .tar.gz)
- ..
- _static
- _templates
- generated
- iapi
- showcases
- uml
- answers.rst
- api.rst
- architecture.rst
- attributes.rst
- bigdata.rst
- book.rst
- capability.rst
- changelog.rst
- coffee.csv
- conf.py
- cookbook.rst
- database.rst
- design.rst
- entity-relationship-diagram.dia
- entity-relationship-diagram.png
- guide.rst
- iapi.rst
- index.rst
- logging.rst
- migration_guide.rst
- note_on_pypy.rst
- plugin_howto.rst
- pyinstaller.rst
- quickstart.rst
- renderers.rst
- sheet.rst
- sources.rst
- spelling_wordlist.txt
- tutorial.rst
- tutorial02.rst
- tutorial03.rst
- tutorial04.rst
- tutorial05.rst
- tutorial06.rst
- tutorial_data_conversion.rst
- tutorial_file.rst
- two-liners.rst
- webdev.rst
api.rst @69aa864 — view markup · raw · history · blame
API Reference
This is intended for users of pyexcel.
Signature functions
Obtaining data from excel file
Saving data to excel file
These flags can be passed on all signature functions:
auto_detect_int
Automatically convert float values to integers if the float number has no decimal values(e.g. 1.00). By default, it does the detection. Setting it to False will turn on this behavior
It has no effect on pyexcel-xlsx because it does that by default.
auto_detect_float
Automatically convert text to float values if possible. This applies only pyexcel-io where csv, tsv, csvz and tsvz formats are supported. By default, it does the detection. Setting it to False will turn on this behavior
auto_detect_datetime
Automatically convert text to python datetime if possible. This applies only pyexcel-io where csv, tsv, csvz and tsvz formats are supported. By default, it does the detection. Setting it to False will turn on this behavior
library
Name a pyexcel plugin to handle a file format. In the situation where multiple plugins were pip installed, it is confusing for pyexcel on which plugin to handle the file format. For example, both pyexcel-xlsx and pyexcel-xls reads xlsx format. Now since version 0.2.2, you can pass on library="pyexcel-xls" to handle xlsx in a specific function call.
It is better to uninstall the unwanted pyexcel plugin using pip if two plugins for the same file type are not absolutely necessary.
Cookbook
Book
Here's the entity relationship between Book, Sheet, Row and Column
