Skip to main content

Read XLSX, XLS and CSV files with a uniform interface Read XLSX, XLS and CSV files with a uniform interface

Project description

* tabular_reader

** Description
A module that maps information from each row in XLSX, XLS, or CSV
files to a ~SimpleNamespace~ object, providing a uniform interface
across different spreadsheet and data formats. Similar to Python's
native [[https://docs.python.org/3/library/csv.html#csv.DictReader][csv.DictReader]] but with support for multiple file types.

** Installing
#+begin_src bash
pip install tabular-reader
#+end_src

** Examples

*** Basic usage with XLSX
#+begin_src python
from tabular_reader import TabularReader

reader = TabularReader("names.xlsx", worksheet="Sheet1")
for row in reader:
print(row.first_name, row.last_name)
#+end_src

Output:
#+begin_src
Boris Johnson
Donald Trump
Mark Rutte
#+end_src

*** Reading CSV files
#+begin_src python
from tabular_reader import TabularReader

reader = TabularReader("data.csv")
for row in reader:
print(row.email, row.phone)
#+end_src

*** Reading XLS files
#+begin_src python
from tabular_reader import TabularReader

reader = TabularReader("legacy_data.xls")
for row in reader:
print(row.id, row.name)
#+end_src

** Custom fieldnames
You can specify fieldnames manually:

#+begin_src python
reader = TabularReader(
"data.xlsx",
fieldnames=["id", "email", "username"]
)
for row in reader:
print(row.id, row.email)
#+end_src

** Skip blank lines
Filter out empty rows:

#+begin_src python
reader = TabularReader(
"data.csv",
skip_blank_lines=True
)
for row in reader:
print(row)
#+end_src

** Keyword arguments

*** For Excel files (XLSX/XLS)
Pass any ~openpyxl.load_workbook~ keyword arguments:

#+begin_src python
reader = TabularReader(
"names.xlsx",
worksheet="Sheet1",
read_only=False,
keep_vba=False,
data_only=False,
keep_links=True
)
#+end_src

*** For CSV files
Pass any ~csv.reader~ keyword arguments:

#+begin_src python
reader = TabularReader(
"data.csv",
delimiter=";",
quotechar='"',
encoding="utf-8"
)
#+end_src

** Features
- Automatic format detection by file extension
- Empty column filtering (only processes columns with headers)
- Uniform interface across XLSX, XLS, and CSV
- ~SimpleNamespace~ objects with attribute access (~row.field_name~)
- Python 3.6 - 3.14 support

** Supported formats
| Format | Extension | Status |
|--------|-----------|-------------|
| Excel | .xlsx | ✓ Supported |
| Excel | .xls | ✓ Supported |
| CSV | .csv | ✓ Supported |

** Acknowledgements
- [[https://openpyxl.readthedocs.io/][openpyxl]]
- [[https://docs.python.org/3/library/csv.html][csv]] - Python's standard library

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

tabular_reader-0.1.1.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

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

tabular_reader-0.1.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file tabular_reader-0.1.1.tar.gz.

File metadata

  • Download URL: tabular_reader-0.1.1.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tabular_reader-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7d98b439694f80d5329244e801e9aa985a51ef6cb370aef1c325f5e8dd890d8b
MD5 6a9e5828bf993f49b09f36fcb24e9c36
BLAKE2b-256 c481c3fbe5afc5c8efccca2172ad59f6a1449d6d2b3bc1a52f611de334201d52

See more details on using hashes here.

Provenance

The following attestation bundles were made for tabular_reader-0.1.1.tar.gz:

Publisher: workflow.yml on arkhan/tabular-reader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tabular_reader-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: tabular_reader-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tabular_reader-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 22de8da8a4c3de8faedec235dad34214ed7a2885a151138beba306a331975261
MD5 fbaa57f3b01c31a6f5f27af166a0a0f3
BLAKE2b-256 bc2b8d54093eed475725937089250d1df80e70fb358aff8d5e3f98f326b96ae1

See more details on using hashes here.

Provenance

The following attestation bundles were made for tabular_reader-0.1.1-py3-none-any.whl:

Publisher: workflow.yml on arkhan/tabular-reader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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