Skip to main content

Uniform way to write table data to and read from different file formats

Project description

tableio

The tableio package contains a number of classes providing a uniform way for a python program to write table data (rows of columns) to and read table data from a number of different common file formats.

An increasing number of users want output from programs to be in a format like a spreadsheet, and not the old fashoned raw text files. Similarly, many users want the data they feed into programs to be in a particular format (like a spreadsheet). The tableio package tries to make it easier for the programmer to fullfil requests like that.

The primary intended use is for data table output from a python program and data table input to a python program, where the programmer would like the user to be able to select the input and output file formats.

The support for spreadsheets is for reading and writing data. There is no intention to support reading or writing formulas. There is no support for running calculations in the spreadsheets (although nothing will stop a receiver of a spreadsheet created by tableio package to manually add formulas in the received spreadsheet).

Installing tableio

Installing tableio on mac and Linux

pip3 install --upgrade tableio

Installing tableio on Microsoft Windows

pip install --upgrade tableio

Supported formats

The currently supported formats are:

File format Implementation Can write Can read
CSV csv yes yes
Excel OpenPyXL yes yes
Excel XlsxWriter yes -
Excel pylightxl yes yes
ODS odfdo yes yes
HTML mformat yes -
LaTeX mformat yes -
docx mformat yes -
md mformat yes -
odt mformat yes -
pdf mformat yes -
reST mformat yes -
rtf mformat yes -
txt mformat yes -

Features

All features are not available for all file formats. Often the file format restricts what features are reasonable in that format. Using a selection mechanism called Capabilities it is possible to select file format at runtime based on what features are essential. It is also possible to ignore some features when using a file format that cannot support that feature (like ignoring bold fomatting in CSV).

The main features are:

  • File open modes: Create, Read or Update
  • Writing tables from list of lists or list of dicts
  • Writing headings before and between tables
  • Reading tables to list of lists or list of dicts, including the headings before the table.
  • formatting per cell or per row:
    • bold format
    • italics format
    • highlight colour
  • reading and writing cells with data types:
    • str
    • bool
    • int
    • float
    • datetime
  • writing a table as a filtered data range
  • writing a table to a specific location in a spreadsheet (specified by a box)
  • reading table data from a specific location in a spreadsheet (specified by a box)
  • using multiple sheets in spreadsheets
  • finding location where some data is present in spreadsheet and doing modifications at that position or at positions relative to that position.

Example programs

The best way to learn to use this package is to use the provided example programs: https://bitbucket.org/tom-bjorkholm/table-io/src/master/example/src/example/README.md.

API documentation

You can find the public API documentation at https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/api.md

You can find the protected API documentation at https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/protected_api.md The protected API documentation is only for developers that want to extend the framework with by adding their own classes as registered readers/writers to the factory.

Even though the API documentation exists, most users and programmers probably get a better start by reading the examples.

Version history

Version Date Python version Comment
0.4 2026 Apr 06 3.12 or newer Fix .xlsx and .ods syntax
0.3 2026 Apr 01 3.12 or newer Improved API, more backends
0.2 2026 Mar 28 3.12 or newer More features, API changes
0.1 2026 Mar 23 3.12 or newer First released version

Test summary

  • Test result: 1126 passed in 17s
  • No flake8 warnings.
  • No mypy errors found.
  • Built version(s): 0.4
  • Build and test using Python 3.14.3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tableio-0.4.tar.gz (65.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tableio-0.4-py3-none-any.whl (74.4 kB view details)

Uploaded Python 3

File details

Details for the file tableio-0.4.tar.gz.

File metadata

  • Download URL: tableio-0.4.tar.gz
  • Upload date:
  • Size: 65.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.14.3

File hashes

Hashes for tableio-0.4.tar.gz
Algorithm Hash digest
SHA256 a45f09168eb301b637ebf68b74cec8ddeb489e209dea66ed872c76e351cfbfb5
MD5 d8a38ffc7b176451fa28952b064898fe
BLAKE2b-256 9747d7058660ccbc2cf5cd830452e22c0de97bb369538ca82e45499fedec018a

See more details on using hashes here.

File details

Details for the file tableio-0.4-py3-none-any.whl.

File metadata

  • Download URL: tableio-0.4-py3-none-any.whl
  • Upload date:
  • Size: 74.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.14.3

File hashes

Hashes for tableio-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 793ada6f53648d89fa065307d0fe2371a036175e88c38c30a177699b0d3c377a
MD5 e2661c8fe80a4c33ccff59cabb88c707
BLAKE2b-256 490bf700f6d7f1fc88c7e29482ac4f4ca10fe6748207ba9042f7244f4c350bcc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page