Skip to main content

Library for developers to extract data from Microsoft Excel (tm) spreadsheet files

Project description

PyPI package version Supported Python versions Supported Python implementations CI status of Linux/macOS/Windows Test coverage

excelrd

excelrd is a modified version of xlrd to work for the latest Python versions. xlrd will not work in Python 3.9 or newer versions.

Purpose: Provide a library for developers to use to extract data from Microsoft Excel (tm) spreadsheet files. It is not an end-user tool.

Author: John Machin

Licence: BSD-style (see licences.py)

Versions of Python supported: 3.5+.

Outside scope: excelrd will safely and reliably ignore any of these if present in the file:

  • Charts, Macros, Pictures, any other embedded object. WARNING: currently this includes embedded worksheets.

  • VBA modules

  • Formulas (results of formula calculations are extracted, of course).

  • Comments

  • Hyperlinks

  • Autofilters, advanced filters, pivot tables, conditional formatting, data validation

  • Handling password-protected (encrypted) files.

Installation

pip install excelrd

Quick start

Print all of the cell values in a specific sheet:

Sample Code:
import excelrd


def main():
    book = excelrd.open_workbook("namesdemo.xls")

    print("The number of worksheets is {}".format(book.nsheets))
    print("Worksheet name(s): {}".format(", ".join(book.sheet_names())))

    sh = book.sheet_by_index(2)
    print("{}: rows={}, cols={}".format(sh.name, sh.nrows, sh.ncols))

    for row_idx in range(sh.nrows):
        for col_idx in range(sh.ncols):
            cell = sh.cell(row_idx, col_idx)

            if not cell.value:
                continue

            print("row={}, col={}, value={}".format(row_idx, col_idx, cell.value))

Transition from xlrd to excelrd

Replace the import from import xlrd to import excelrd:

import excelrd as xlrd

Another quick start

This will show the first, second and last rows of each sheet in each file:

python PYDIR/scripts/runxlrd.py 3rows *blah*.xls

Acknowledgements

  • This package started life as a translation from C into Python of parts of a utility called “xlreader” developed by David Giffin. “This product includes software developed by David Giffin david@giffin.org.”

  • OpenOffice.org has truly excellent documentation of the Microsoft Excel file formats and Compound Document file format, authored by Daniel Rentz. See http://sc.openoffice.org

  • U+5F20 U+654F: over a decade of inspiration, support, and interesting decoding opportunities.

  • Ksenia Marasanova: sample Macintosh and non-Latin1 files, alpha testing

  • Backporting to Python 2.1 was partially funded by Journyx - provider of timesheet and project accounting solutions (http://journyx.com/).

  • Provision of formatting information in version 0.6.1 was funded by Simplistix Ltd (http://www.simplistix.co.uk/)

Documentation

https://excelrd.rtfd.io/

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

excelrd-3.0.0.tar.gz (742.8 kB view details)

Uploaded Source

Built Distribution

excelrd-3.0.0-py3-none-any.whl (105.7 kB view details)

Uploaded Python 3

File details

Details for the file excelrd-3.0.0.tar.gz.

File metadata

  • Download URL: excelrd-3.0.0.tar.gz
  • Upload date:
  • Size: 742.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for excelrd-3.0.0.tar.gz
Algorithm Hash digest
SHA256 155ef640aca4f8bf2e6094a6093a9f968f3e968c88f231232b4bda4553752e35
MD5 12bfe3c249de8387de070928becc752c
BLAKE2b-256 38f6faf728706f396c7bc5acfdb734b9043de6cac1acae9f66db347f870eaf42

See more details on using hashes here.

File details

Details for the file excelrd-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: excelrd-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 105.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for excelrd-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21d76a5ee0992139fb7979d736ae28d17b6369d5be897fbd963c623dbf00acc4
MD5 deff9a2638b37230702f15cf9297e960
BLAKE2b-256 d3c335576d35825191871e33398d8a09c5896588ce8fb789f458b0dbd79934cf

See more details on using hashes here.

Supported by

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