Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c9e47c6

Browse filesBrowse files
committed
Restructure index, readme and acknowledgments.
1 parent 2c3e7ec commit c9e47c6
Copy full SHA for c9e47c6

File tree

Expand file treeCollapse file tree

4 files changed

+76
-73
lines changed
Filter options
Expand file treeCollapse file tree

4 files changed

+76
-73
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
-58Lines changed: 0 additions & 58 deletions
This file was deleted.

‎README.rst

Copy file name to clipboard
+56Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
xlrd
2+
====
3+
4+
|Build Status|_ |Coverage Status|_ |Documentation|_ |PyPI version|_
5+
6+
.. |Build Status| image:: https://circleci.com/gh/python-excel/xlrd/tree/master.svg?style=shield
7+
.. _Build Status: https://circleci.com/gh/python-excel/xlrd/tree/master
8+
9+
.. |Coverage Status| image:: https://codecov.io/gh/python-excel/xlrd/branch/master/graph/badge.svg?token=lNSqwBBbvk
10+
.. _Coverage Status: https://codecov.io/gh/python-excel/xlrd
11+
12+
.. |Documentation| image:: https://readthedocs.org/projects/xlrd/badge/?version=latest
13+
.. _Documentation: http://xlrd.readthedocs.io/en/latest/?badge=latest
14+
15+
.. |PyPI version| image:: https://badge.fury.io/py/xlrd.svg
16+
.. _PyPI version: https://badge.fury.io/py/xlrd
17+
18+
19+
xlrd is a library for reading data and formatting information from Excel
20+
files in the historical ``.xls`` format.
21+
22+
.. warning::
23+
24+
This library will no longer read anything other than ``.xls`` files. For
25+
alternatives that read newer file formats, please see http://www.python-excel.org/.
26+
27+
The following are also not supported but will safely and reliably be ignored:
28+
29+
* Charts, Macros, Pictures, any other embedded object, **including** embedded worksheets.
30+
* VBA modules
31+
* Formulas, but results of formula calculations are extracted.
32+
* Comments
33+
* Hyperlinks
34+
* Autofilters, advanced filters, pivot tables, conditional formatting, data validation
35+
36+
Password-protected files are not supported and cannot be read by this library.
37+
38+
Quick start:
39+
40+
.. code-block:: python
41+
42+
import xlrd
43+
book = xlrd.open_workbook("myfile.xls")
44+
print("The number of worksheets is {0}".format(book.nsheets))
45+
print("Worksheet name(s): {0}".format(book.sheet_names()))
46+
sh = book.sheet_by_index(0)
47+
print("{0} {1} {2}".format(sh.name, sh.nrows, sh.ncols))
48+
print("Cell D30 is {0}".format(sh.cell_value(rowx=29, colx=3)))
49+
for rx in range(sh.nrows):
50+
print(sh.row(rx))
51+
52+
From the command line, this will show the first, second and last rows of each sheet in each file:
53+
54+
.. code-block:: bash
55+
56+
python PYDIR/scripts/runxlrd.py 3rows *blah*.xls

‎docs/acknowledgements.rst

Copy file name to clipboardExpand all lines: docs/acknowledgements.rst
+12-5Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
Acknowledgements
22
================
33

4+
Many thanks to to John Machin for originally writing :mod:`xlrd` and tirelessly
5+
supporting it for many years before retiring.
6+
7+
* 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>."
8+
* 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
9+
* U+5F20 U+654F: over a decade of inspiration, support, and interesting decoding opportunities.
10+
* Ksenia Marasanova: sample Macintosh and non-Latin1 files, alpha testing
11+
* Backporting to Python 2.1 was partially funded by Journyx - provider of timesheet and project accounting solutions (http://journyx.com/).
12+
* Provision of formatting information in version 0.6.1 was funded by `Simplistix Ltd`__.
13+
14+
__ http://www.simplistix.co.uk
15+
416
Development of this package would not have been possible without the document
517
OpenOffice.org's Documentation of the Microsoft Excel File Format"
618
("OOo docs" for short).
@@ -18,8 +30,3 @@ Backporting to Python 2.1 was partially funded by
1830
`Journyx - provider of timesheet and project accounting solutions`__.
1931

2032
__ http://journyx.com/
21-
22-
Provision of formatting information in version 0.6.1 was funded by
23-
`Simplistix Ltd`__.
24-
25-
__ http://www.simplistix.co.uk

‎docs/index.rst

Copy file name to clipboardExpand all lines: docs/index.rst
+8-10Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
xlrd documentation
2-
==================
1+
.. include:: ../README.rst
2+
3+
You may also wish to consult the `tutorial`__.
4+
5+
__ https://github.com/python-excel/tutorial
36

4-
xlrd is a library for reading data and formatting information from Excel
5-
files, whether they are .xls or .xlsx files.
7+
Details:
68

79
.. toctree::
810
:maxdepth: 1
@@ -14,12 +16,8 @@ files, whether they are .xls or .xlsx files.
1416
on_demand.rst
1517
api.rst
1618

17-
You may also wish to consult the `tutorial`__.
18-
19-
__ https://github.com/python-excel/tutorial
20-
21-
For details of how to install the package or get involved in its
22-
development, please see the sections below:
19+
For details of how to get involved in development of this package,
20+
and other meta-information, please see the sections below:
2321

2422
.. toctree::
2523
:maxdepth: 1

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.