https://github.com/thombashi/excelrd

excelrd is a modified version of xlrd to work for the latest Python versions.
https://github.com/thombashi/excelrd

excel excel-reader python-library xlrd

Last synced: about 1 month ago
JSON representation

excelrd is a modified version of xlrd to work for the latest Python versions.

• Host: GitHub
• URL: https://github.com/thombashi/excelrd
• Owner: thombashi
• License: other
• Created: 2020-01-05T04:27:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-08T06:59:03.000Z (about 1 year ago)
• Last Synced: 2024-05-17T00:01:45.668Z (4 months ago)
• Topics: excel, excel-reader, python-library, xlrd
• Language: Python
• Homepage: https://excelrd.rtfd.io/
• Size: 4.02 MB
• Stars: 9
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - thombashi/excelrd - excelrd is a modified version of xlrd to work for the latest Python versions. (Python)

README

        
.. contents:: **excelrd**

   :backlinks: top

   :depth: 2

.. image:: https://badge.fury.io/py/excelrd.svg

    :target: https://badge.fury.io/py/excelrd

    :alt: PyPI package version

.. image:: https://img.shields.io/pypi/pyversions/excelrd.svg

    :target: https://pypi.org/project/excelrd

    :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/implementation/excelrd.svg

    :target: https://pypi.org/project/excelrd

    :alt: Supported Python implementations

.. image:: https://github.com/thombashi/excelrd/actions/workflows/ci.yml/badge.svg

    :target: https://github.com/thombashi/excelrd/actions/workflows/ci.yml

    :alt: CI status of Linux/macOS/Windows

.. image:: https://coveralls.io/repos/github/thombashi/excelrd/badge.svg?branch=master

    :target: https://coveralls.io/github/thombashi/excelrd?branch=master

    :alt: 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:

    .. code:: python

        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``:

.. code:: python

    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

   [email protected]."

-  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/