[Python-modules-commits] [python-xlrd] 02/08: New upstream release.

Vincent Bernat bernat at moszumanska.debian.org
Tue Nov 14 07:38:54 UTC 2017


This is an automated email from the git hooks/post-receive script.

bernat pushed a commit to annotated tag debian/1.1.0-1
in repository python-xlrd.

commit c372567887e78ff6940f7c14b9f476236a7fd4ed
Author: Vincent Bernat <bernat at debian.org>
Date:   Tue Nov 14 08:21:28 2017 +0100

    New upstream release.
---
 .gitignore                       |    1 +
 .travis.yml                      |    7 +-
 HISTORY.html                     |  339 -------
 MANIFEST.in                      |    2 -
 PKG-INFO                         |    8 +-
 README.md                        |   50 +-
 build.txt                        |   12 -
 docs/Makefile                    |  135 +++
 docs/acknowledgements.rst        |   25 +
 docs/api.rst                     |   67 ++
 docs/changes.rst                 |  546 ++++++++++
 docs/conf.py                     |   25 +
 docs/dates.rst                   |   87 ++
 docs/development.rst             |   64 ++
 docs/formatting.rst              |  124 +++
 docs/index.rst                   |   39 +
 docs/installation.rst            |   18 +
 docs/licenses.rst                |   80 ++
 docs/make.bat                    |  178 ++++
 docs/on_demand.rst               |   57 ++
 docs/references.rst              |   39 +
 docs/unicode.rst                 |   37 +
 docs/vulnerabilities.rst         |   54 +
 make_doc.bat                     |    6 -
 pkg_doc.py                       |   31 -
 pythondoc.py                     | 1428 --------------------------
 scripts/runxlrd.py               |   12 +-
 setup.cfg                        |    4 +-
 setup.py                         |   32 +-
 tests/err_cell_empty.xlsx        |  Bin 0 -> 127624 bytes
 tests/issue85.xls                |  Bin 9090560 -> 0 bytes
 tests/test_cell.py               |    2 +-
 tests/test_formulas.py           |   16 +-
 tests/test_open_workbook.py      |    7 +-
 tests/test_sheet.py              |    2 +-
 tests/test_workbook.py           |    3 +-
 tox.ini                          |    2 +-
 xlrd.egg-info/PKG-INFO           |    8 +-
 xlrd.egg-info/SOURCES.txt        |   29 +-
 xlrd.egg-info/not-zip-safe       |    1 +
 xlrd/__init__.py                 |  441 ++------
 xlrd/biffh.py                    |   66 +-
 xlrd/book.py                     |  471 +++++----
 xlrd/compdoc.py                  |   90 +-
 xlrd/doc/compdoc.html            |   69 --
 xlrd/doc/xlrd.html               | 2064 --------------------------------------
 xlrd/examples/xlrdnameAPIdemo.py |    4 +-
 xlrd/formatting.py               |  558 ++++++-----
 xlrd/formula.py                  |  342 ++++---
 xlrd/info.py                     |    2 +-
 xlrd/licences.py                 |   77 --
 xlrd/sheet.py                    | 1038 ++++++++++---------
 xlrd/timemachine.py              |    6 +-
 xlrd/xldate.py                   |  190 ++--
 xlrd/xlsx.py                     |   24 +-
 55 files changed, 3225 insertions(+), 5794 deletions(-)

diff --git a/.gitignore b/.gitignore
index 6117420..0e7af87 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,7 @@
 /dist
 *.egg-info
 build/
+_build/
 *.pyc
 /.coverage
 /.tox
diff --git a/.travis.yml b/.travis.yml
index aad6d52..b83129c 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -4,14 +4,15 @@ sudo: false
 language: python
 
 python:
+  - "3.6"
   - "3.5"
   - "3.4"
-  - "3.3"
   - "2.7"
-  - "2.6"
 
 # command to install dependencies
-install: "pip install -Ur requirements.txt"
+install: 
+- "pip install -U pip setuptools"
+- "pip install -Ur requirements.txt"
 
 # command to run tests, e.g. python setup.py test
 script: nosetests --with-cov --cov=xlrd
diff --git a/HISTORY.html b/HISTORY.html
deleted file mode 100644
index 32f2635..0000000
--- a/HISTORY.html
+++ /dev/null
@@ -1,339 +0,0 @@
-TODO -- refer to svn log if you really need to know :-)
-
-<p> Revision : 3782 -- Author: sjmachin -- Date: 2009-02-23 23:00:50
-</p><ul>
-     <li> colname utility function now supports more than 256 columns.
-</li><li> Fix bug where BIFF record type 0x806 was being regarded as a formula opcode.
-</li><li> Ignore PALETTE record when formatting_info is false.
-</li><li> Tolerate up to 4 bytes trailing junk on PALETTE record.
-</li><li> Fixed bug in unused utility function xldate_from_date_tuple which affected some years after 2099.
-</li><li> Added code for inspecting as-yet-unused record types: FILEPASS, TXO, NOTE.
-</li><li> Added inspection code for add_in function calls.
-</li><li> Added support for unnumbered biff_dump (better for doing diffs).
-</li></ul>
-<p> Revision : 3613 -- Author: chris -- Date: 2008-11-22 04:06:36
-</p><ul>
-     <li> ignore distutils cruft
-</li></ul>
-<p> Revision : 3574 -- Author: sjmachin -- Date: 2008-11-04 11:51:20
-</p><ul>
-     <li> Avoid assertion error in compdoc when -1 used instead of -2 for first_SID of empty SCSS
-</li></ul>
-<p> Revision : 3480 -- Author: chris -- Date: 2008-09-19 20:43:00
-</p><ul>
-     <li> Make version numbers match up.
-</li></ul>
-<p> Revision : 3431 -- Author: sjmachin -- Date: 2008-07-28 10:37:35
-</p><ul>
-     <li> Enhanced recovery from out-of-order/missing/wrong CODEPAGE record.
-</li><li> Added Name.area2d convenience method.
-</li><li> Avoided some checking of XF info when formatting_info is false.
-</li><li> Minor changes in preparation for XLSX support.
-</li></ul>
-<p> Revision : 3311 -- Author: chris -- Date: 2008-03-14 22:09:01
-</p><ul>
-     <li> remove duplicate files that were out of date.
-</li></ul>
-<p> Revision : 3287 -- Author: sjmachin -- Date: 2008-02-14 06:33:32
-</p><ul>
-     <li> Basic support for Excel 2.0
-</li></ul>
-<p> Revision : 3284 -- Author: sjmachin -- Date: 2008-02-09 05:37:57
-</p><ul>
-     <li> Decouple Book init & load.
-</li><li> runxlrd: minor fix for xfc.
-</li><li> More Excel 2.x work.
-</li><li> is_date_format() tweak.
-</li><li> Better detection of IronPython.
-</li></ul>
-<p> Revision : 3265 -- Author: sjmachin -- Date: 2007-12-25 19:09:45
-</p><ul>
-     <li> Better error message (including first 8 bytes of file) when file is not in a supported format.
-</li></ul>
-<p> Revision : 3263 -- Author: sjmachin -- Date: 2007-12-20 07:04:55
-</p><ul>
-     <li> More BIFF2 formatting: ROW, COLWIDTH, and COLUMNDEFAULT records;
-</li><li> finished stage 1 of XF records.
-</li></ul>
-<p> Revision : 3262 -- Author: sjmachin -- Date: 2007-12-11 07:40:33
-</p><ul>
-     <li> More work on supporting BIFF2 (Excel 2.x) files.
-</li></ul>
-<p> Revision : 3250 -- Author: sjmachin -- Date: 2007-12-04 20:37:14
-</p><ul>
-     <li> Added support for Excel 2.x (BIFF2) files. Data only, no formatting info. Alpha.
-</li></ul>
-<p> Revision : 3234 -- Author: sjmachin -- Date: 2007-11-21 00:55:56
-</p><ul>
-     <li> Wasn't coping with EXTERNSHEET record followed by CONTINUE record(s).
-</li></ul>
-<p> Revision : 3168 -- Author: sjmachin -- Date: 2007-10-13 09:19:01
-</p><ul>
-     <li> Allow for BIFF2/3-style FORMAT record in BIFF4/8 file
-</li><li> Avoid crash when zero-length Unicode string missing options byte.
-</li><li> Warning message if sector sizes are extremely large.
-</li><li> Work around corrupt STYLE record
-</li><li> Added missing entry for blank cell type to ctype_text
-</li><li> Added "fonts" command to runxlrd script
-</li><li> Warning: style XF whose parent XF index != 0xFFF
-</li></ul>
-<p> Revision : 2868 -- Author: sjmachin -- Date: 2007-07-11 11:02:55
-</p><ul>
-     <li> Logfile arg wasn't being passed from open_workbook to compdoc.CompDoc.
-</li></ul>
-
-<p>  Version 0.6.1, 2007-06-10
-</p>
-<ul>
-<li> Version number updated to 0.6.1
-</li>
-<li> Documented runxlrd.py commands in its usage message. Changed commands: dump to biff_dump, count_records to biff_count.
-</li>
-</ul>
-
-<p>  Version 0.6.1a5
-</p>
-<ul>
-<li> Bug fixed: Missing "<" in a struct.unpack call means can't open files on bigendian platforms. Discovered by "Mihalis".
-</li>
-<li> Removed antique undocumented Book.get_name_dict method and experimental "trimming" facility.
-</li>
-<li> Meaningful exception instead of IndexError if a SAT (sector allocation table) is corrupted.
-</li>
-<li> If no CODEPAGE record in pre-8.0 file, assume ascii and keep going (instead of raising exception).
-</li>
-</ul>
-
-<p>  Version 0.6.1a4
-</p>
-<ul>
-<li> At least one source of XLS files writes parent style XF records *after* the child cell
-     XF records that refer to them, triggering IndexError in 0.5.2 and AssertionError in
-     later versions.
-     Reported with sample file by Todd O'Bryan.
-     Fixed by changing to two-pass processing of XF records.
-</li>
-<li> Formatting info in pre-BIFF8 files: Ensured appropriate defaults and lossless conversions to make
-     the info BIFF8-compatible. Fixed bug in extracting the "used" flags.
-</li>
-<li> Fixed problems discovered with opening test files from Planmaker 2006
-     (http://www.softmaker.com/english/ofwcomp_en.htm):
-     (1) Four files have reduced size of PALETTE record
-     (51 and 32 colours; Excel writes 56 always). xlrd now emits a NOTE to the logfile and continues.
-     (2) FORMULA records use the Excel 2.x record code 0x0021 instead of 0x0221. xlrd now continues silently.
-     (3) In two files, at the OLE2 compound document level, the internal directory says that the length of
-     the Short-Stream Container Stream is 16384 bytes, but the actual contents are 11264 and 9728 bytes respectively.
-     xlrd now emits a WARNING to the logfile and continues.
-</li>
-<li> After discussion with Daniel Rentz, the concept of two lists of XF (eXtended Format) objects
-     (raw_xf_list and computed_xf_list) has been abandoned. There is now a single list, called xf_list
-</li>
-</ul>
-
-<p>  Version 0.6.1a3
-</p>
-<ul>
-<li> Added Book.sheets ... for sheetx, sheet in enumerate(book.sheets):
-</li>
-<li> Formatting info: extraction of sheet-level flags from WINDOW2 record, and sheet.visibility
-     from BOUNDSHEET record. Added Macintosh-only Font attributes "outline" and "shadow'.
-</li>
-</ul>
-
-<p>  Version 0.6.1a2
-</p>
-<ul>
-<li> Added extraction of merged cells info.
-</li>
-<li> pyExcelerator uses "general" instead of "General" for the generic "number format". Worked around.
-</li>
-<li> Crystal Reports writes "WORKBOOK" in the OLE2 Compound Document directory instead of "Workbook".
-     Changed to case-insensitive directory search. Reported by Vic Simkus.
-</li>
-</ul>
-
-<p>  Version 0.6.1a1, 2006-12-18
-</p>
-<ul>
-<li> Added formatting information for cells (font, "number format", background, border, alignment and protection)
-     and rows/columns (height/width etc). To save memory and time for those who don't need it,
-     this information is extracted only if formatting_info=1 is supplied
-     to the open_workbook() function. The cell records BLANK and MULBLANKS
-     which contain no data, only formatting information, will continue to be ignored
-     in the default (no formatting info) case.
-</li>
-<li> Ralph Heimburger reported a problem with xlrd being intolerant
-     about an Excel 4.0 file (created by "some web app") with a DIMENSIONS record
-     that omitted Microsoft's usual padding with 2 unused bytes. Fixed.
-</li>
-</ul>
-
-<p>  Version 0.6.0a4, not released
-</p>
-<ul>
-<li> Added extraction of human-readable formulas from NAME records.
-</li>
-<li> Worked around OOo Calc writing 9-byte BOOLERR records instead of 8. Reported by Rory Campbell-Lange.
-</li>
-<li> This history file converted to descending chronological order and HTML format.
-</li>
-</ul>
-
-<p>  Version 0.6.0a3, 2006-09-19
-</p>
-<ul>
-<li> Names: minor bugfixes; added script xlrdnameAPIdemo.py
-</li>
-<li> ROW records were being used as additional hints for sizing memory requirements. In some
-     files the ROW records overstate the number of used columns, and/or there are ROW records for
-     rows that have no data in them. This would cause xlrd to report sheet.ncols and/or sheet.nrows
-     as larger than reasonably expected. Change: ROW records are ignored. The number of columns/rows is
-     based solely on the highest column/row index seen in non-empty data records. Empty data records (types
-     BLANK and MULBLANKS) which contain no data, only formatting information, have always been ignored, and
-     this will continue. Consequence: trailing rows and columns which contain only empty cells will
-     vanish.
-</li>
-</ul>
-
-<p>  Version 0.6.0a2, 2006-09-13
-</p>
-<ul>
-<li> Fixed a bug reported by Rory Campbell-Lange.: "open failed"; incorrect assumptions about the layout
-     of array formulas which return strings.
-</li>
-<li> Further work on defined names, especially the API.
-</li>
-</ul>
-
-<p>  Version 0.6.0a1, 2006-09-08
-</p>
-<ul>
-<li> Sheet objects have two new convenience methods: col_values(colx, start_rowx=0, end_rowx=None)
-     and the corresponding col_types. Suggested by Dennis O'Brien.
-</li>
-<li> BIFF 8 file missing its CODEPAGE record: xlrd will now assume utf_16_le encoding
-     (the only possibility) and keep going.
-</li>
-<li> Older files missing a CODEPAGE record: an exception will be raised.
-     Thanks to Sergey Krushinsky for a sample file.
-     The open_workbook() function has a new argument (encoding_override) which can
-     be used if the CODEPAGE record is missing or incorrect (for example, codepage=1251
-     but the data is actually encoded in koi8_r). The runxlrd.py script takes a
-     corresponding -e argument, for example -e cp1251
-</li>
-<li> Further work done on parsing "number formats". Thanks to Chris Withers for the
-     "General_)" example.
-</li>
-<li> Excel 97 introduced the concept of row and column labels, defined by Insert > Name > Labels.
-     The ranges containing the labels are now exposed as the Sheet attributes
-     row_label_ranges and col_label_ranges.
-</li>
-<li> The major effort in this 0.6.0 release has been the provision of access
-     to named cell ranges and named constants (Excel: Insert/Name/Define).
-     Juan C. M�ndez provided very useful real-world sample files.
-</li>
-</ul>
-
-<p>  Version 0.5.3a1, 2006-05-24
-</p>
-<ul>
-<li> John Popplewell and Richard Sharp provided sample files which caused any
-     reliance at all on DIMENSIONS records and ROW records to be abandoned.
-</li>
-<li> If the file size is not a whole number of OLE sectors, a warning message is logged.
-     Previously this caused an exception to be raised.
-</li>
-</ul>
-
-<p>  Version 0.5.2, 2006-03-14, public release
-</p>
-<ul>
-<li> Updated version numbers, README, HISTORY.
-</li>
-</ul>
-
-<p>  Version 0.5.2a3, 2006-03-13
-</p>
-<ul>
-<li> Gnumeric writes user-defined formats with format codes starting at
-     50 instead of 164; worked around.
-</li>
-<li> Thanks to Didrik Pinte for reporting the need for xlrd to be more tolerant
-     of the idiosyncracies of other software, for supplying sample files,
-     and for performing alpha testing.
-</li>
-<li> '_' character in a format should be treated like an escape character; fixed.
-</li>
-<li> An "empty" formula result means a zero-length string, not an empty cell! Fixed.
-</li>
-</ul>
-
-<p>  Version 0.5.2a2, 2006-03-09
-</p>
-<ul>
-<li> Found that Gnumeric writes all DIMENSIONS records with nrows and ncols
-     each 1 less than they should be (except when it clamps ncols at 256!),
-     and pyXLwriter doesn't write ROW records. Cell memory pre-allocation was
-     generalised to use ROW records if available with fall-back to DIMENSIONS records.
-</li>
-</ul>
-
-<p>  Version 0.5.2a1, 2006-03-06
-</p>
-<ul>
-<li> pyXLwriter writes DIMENSIONS record with antique opcode 0x0000
-     instead of 0x0200; worked around
-</li>
-<li> A file written by Gnumeric had zeroes in DIMENSIONS record
-     but data in cell A1; worked around
-</li>
-</ul>
-
-<p>  Version 0.5.1, 2006-02-18, released to Journyx
-</p>
-<ul>
-<li> Python 2.1 mmap requires file to be opened for update access.
-     Added fall-back to read-only access without mmap if 2.1 open fails
-     because "permission denied".
-</li>
-</ul>
-
-<p>  Version 0.5, 2006-02-07, released to Journyx
-</p>
-<ul>
-<li> Now works with Python 2.1. Backporting to Python 2.1 was partially
-     funded by Journyx - provider of timesheet and project accounting
-     solutions (http://journyx.com/)
-</li>
-<li> open_workbook() can be given the contents of a file
-     instead of its name. Thanks to Remco Boerma for the suggestion.
-</li>
-<li> New module attribute __VERSION__ (as a string; for example "0.5")
-</li>
-<li> Minor enhancements to classification of formats as date or not-date.
-</li>
-<li> Added warnings about files with inconsistent OLE compound document
-     structures. Thanks to Roman V. Kiseliov (author of pyExcelerator)
-     for the tip-off.
-</li>
-</ul>
-
-<p>  Version 0.4a1, 2005-09-07, released to Laurent T.
-</p>
-<ul>
-<li> Book and sheet objects can now be pickled and unpickled.
-     Instead of reading a large spreadsheet multiple times,
-     consider pickling it once and loading the saved pickle;
-     can be much faster. Thanks to Laurent Thioudellet for the
-     enhancement request.
-</li>
-<li> Using the mmap module can be turned off.
-     But you would only do that for benchmarking purposes.
-</li>
-<li> Handling NUMBER records has been made faster
-</li>
-</ul>
-
-<p>  Version 0.3a1, 2005-05-15, first public release
-</p>
-
diff --git a/MANIFEST.in b/MANIFEST.in
deleted file mode 100644
index fa919f4..0000000
--- a/MANIFEST.in
+++ /dev/null
@@ -1,2 +0,0 @@
-include README.html
-recursive-include tests *.py *.xls *.xlsx
diff --git a/PKG-INFO b/PKG-INFO
index 345f3b4..f10db96 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,12 +1,12 @@
 Metadata-Version: 1.1
 Name: xlrd
-Version: 1.0.0
+Version: 1.1.0
 Summary: Library for developers to extract data from Microsoft Excel (tm) spreadsheet files
 Home-page: http://www.python-excel.org/
 Author: John Machin
 Author-email: sjmachin at lexicon.net
 License: BSD
-Description: Extract data from Excel spreadsheets (.xls and .xlsx, versions 2.0 onwards) on any platform. Pure Python (2.6, 2.7, 3.2+). Strong support for Excel dates. Unicode-aware.
+Description: Extract data from Excel spreadsheets (.xls and .xlsx, versions 2.0 onwards) on any platform. Pure Python (2.7, 3.4+). Strong support for Excel dates. Unicode-aware.
 Keywords: xls,excel,spreadsheet,workbook
 Platform: Any platform -- don't need Windows
 Classifier: Development Status :: 5 - Production/Stable
@@ -14,7 +14,11 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Database
 Classifier: Topic :: Office/Business
diff --git a/README.md b/README.md
index 71d8eae..07ed665 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,11 @@
-### Python package "xlrd"
+[![Build Status](https://travis-ci.org/python-excel/xlrd.svg?branch=master)](https://travis-ci.org/python-excel/xlrd)
+[![Coverage Status](https://coveralls.io/repos/github/python-excel/xlrd/badge.svg?branch=master)](https://coveralls.io/github/python-excel/xlrd?branch=master)
+[![Documentation Status](https://readthedocs.org/projects/xlrd/badge/?version=latest)](http://xlrd.readthedocs.io/en/latest/?badge=latest)
+[![PyPI version](https://badge.fury.io/py/xlrd.svg)](https://badge.fury.io/py/xlrd)
+
+### xlrd
+
+Please read this before using this library: https://groups.google.com/d/msg/python-excel/P6TjJgFVjMI/g8d0eWxTBQAJ
 
 **Purpose**: Provide a library for developers to use to extract data from Microsoft Excel (tm) spreadsheet files. It is not an end-user tool.
 
@@ -6,15 +13,11 @@
 
 **Licence**: BSD-style (see licences.py)
 
-**Versions of Python supported**: 2.6, 2.7, 3.2+.
+**Versions of Python supported**: 2.7, 3.4+.
 
 **External modules required**:
 
-<dl>
-
-<dd>The package itself is pure Python with no dependencies on modules or packages outside the standard Python distribution.</dd>
-
-</dl>
+The package itself is pure Python with no dependencies on modules or packages outside the standard Python distribution.
 
 **Outside the current scope**: xlrd will safely and reliably ignore any of these if present in the file:
 
@@ -38,26 +41,21 @@
 
 **Quick start**:
 
-```
-    import xlrd
-    book = xlrd.open_workbook("myfile.xls")
-    print "The number of worksheets is", book.nsheets
-    print "Worksheet name(s):", book.sheet_names()
-    sh = book.sheet_by_index(0)
-    print sh.name, sh.nrows, sh.ncols
-    print "Cell D30 is", sh.cell_value(rowx=29, colx=3)
-    for rx in range(sh.nrows):
-        print sh.row(rx)
-    # Refer to docs for more details.
-    # Feedback on API is welcomed.
-
+```python
+import xlrd
+book = xlrd.open_workbook("myfile.xls")
+print("The number of worksheets is {0}".format(book.nsheets))
+print("Worksheet name(s): {0}".format(book.sheet_names()))
+sh = book.sheet_by_index(0)
+print("{0} {1} {2}".format(sh.name, sh.nrows, sh.ncols))
+print("Cell D30 is {0}".format(sh.cell_value(rowx=29, colx=3)))
+for rx in range(sh.nrows):
+    print(sh.row(rx))
 ```
 
 **Another quick start**: This will show the first, second and last rows of each sheet in each file:
 
-```
-    OS-prompt>python PYDIR/scripts/runxlrd.py 3rows *blah*.xls
-```
+    python PYDIR/scripts/runxlrd.py 3rows *blah*.xls
 
 **Installation**:
 
@@ -66,11 +64,6 @@
 *   If PYDIR is your Python installation directory: the main files are in PYDIR/Lib/site-packages/xlrd the docs are in the doc subdirectory, and there's a sample script: PYDIR/Scripts/runxlrd.py
 *   If os.sep != "/": make the appropriate adjustments.
 
-**Download URLs**:
-
-*   http://pypi.python.org/pypi/xlrd
-*   http://www.lexicon.net/sjmachin/xlrd.htm
-
 **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 at giffin.org>."
@@ -79,4 +72,3 @@
 *   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/)
-*   << a growing list of names; see HISTORY.html >>: feedback, testing, test files, ...
diff --git a/build.txt b/build.txt
deleted file mode 100644
index d6fae8f..0000000
--- a/build.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-Instructions to build releases
-------------------------------
-
-- Make sure you run tests
-
-~/virtualenvs/tox/bin/tox -e py26,py27,py32,py33
-
-- Change the version in xlrd.info.__VERSION__
-
-- Create tag.
-
-- Push to Travis.
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..a463518
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,135 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/acknowledgements.rst b/docs/acknowledgements.rst
new file mode 100644
index 0000000..d4d3874
--- /dev/null
+++ b/docs/acknowledgements.rst
@@ -0,0 +1,25 @@
+Acknowledgements
+================
+
+Development of this package would not have been possible without the document
+OpenOffice.org's Documentation of the Microsoft Excel File Format"
+("OOo docs" for short).
+The latest version is available from OpenOffice.org in
+`PDF format`__ and `ODT format`__.
+Small portions of the OOo docs are reproduced in this
+document. A study of the OOo docs is recommended for those who wish a
+deeper understanding of the Excel file layout than the xlrd docs can provide.
+
+__ http://sc.openoffice.org/excelfileformat.pdf
+
+__ http://sc.openoffice.org/excelfileformat.odt
+
+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
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..7e4f643
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,67 @@
+API Reference
+=============
+
+xlrd
+----
+
+.. automodule:: xlrd
+   :members:
+
+xlrd.biffh
+----------
+
+.. automodule:: xlrd.biffh
+   :members:
+
+xlrd.book
+---------
+
+.. automodule:: xlrd.book
+   :members:
+
+xlrd.compdoc
+------------
+
+.. automodule:: xlrd.compdoc
+   :members:
+
+xlrd.formatting
+---------------
+
+.. automodule:: xlrd.formatting
+   :members:
+
+xlrd.formula
+-------------
+
+.. automodule:: xlrd.formula
+   :members:
+
+xlrd.sheet
+----------
+
+.. currentmodule:: xlrd.sheet
+
+.. autoclass:: xlrd.sheet.Sheet
+   :members:
+   :exclude-members: gcw, col
+
+   .. method:: col(colx)
+
+     Returns a sequence of the :class:`Cell` objects in the given column.
+
+   .. autoattribute:: xlrd.sheet.Sheet.gcw
+      :annotation:
+
+
+.. automodule:: xlrd.sheet
+   :members:
+   :exclude-members: Sheet
+
+xlrd.xldate
+-----------
+
+.. currentmodule:: xlrd.xldate
+
+.. automodule:: xlrd.xldate
+   :members:
diff --git a/docs/changes.rst b/docs/changes.rst
new file mode 100644
index 0000000..092eee2
--- /dev/null
+++ b/docs/changes.rst
@@ -0,0 +1,546 @@
+Changes
+=======
+
+.. currentmodule:: xlrd
+
+1.1.0 (22 August 2017)
+----------------------
+
+- Fix for parsing of merged cells containing a single cell reference in xlsx
+  files.
+
+- Fix for "invalid literal for int() with base 10: 'true'" when reading some
+  xlsx files.
+
+- Make xldate_as_datetime available to import direct from xlrd.
+
+- Build universal wheels.
+
+- Sphinx documentation.
+
+- Document the problem with XML vulnerabilities in xlsx files and mitigation
+  measures.
+
+- Fix :class:`NameError` on ``has_defaults is not defined``.
+
+- Some whitespace and code style tweaks.
+
+- Make example in README compatible with both Python 2 and 3.
+
+- Add default value for cells containing errors that causeed parsing of some
+  xlsx files to fail.
+
+- Add Python 3.6 to the list of supported Python versions, drop 3.3 and 2.6.
+
+- Use generator expressions to avoid unnecessary lists in memory.
+
+- Document unicode encoding used in Excel files from Excel 97 onwards.
+
+- Report hyperlink errors in R1C1 syntax.
+
+Thanks to the following for their contributions to this release:
+
+- icereval at gmail.com
+- Daniel Rech
+- Ville Skyttä
+- Yegor Yefremov
+- Maxime Lorant
+- Alexandr N Zamaraev
+- Zhaorong Ma
+- Jon Dufresne
+- Chris McIntyre
+- coltleese at gmail.com
+- Ivan Masá
+
+1.0.0 (2 June 2016)
+-------------------
+
+- Official support, such as it is, is now for 2.6, 2.7, 3.3+
+
+- Fixes a bug in looking up non-lowercase sheet filenames by ensuring that the
+  sheet targets are transformed the same way as the component_names dict keys.
+
+- Fixes a bug for ``ragged_rows=False`` when merged cells increases the number
+  of columns in the sheet. This requires all rows to be extended to ensure equal
+  row lengths that match the number of columns in the sheet.
+
+- Fixes to enable reading of SAP-generated .xls files.
+
+- support BIFF4 files with missing FORMAT records.
+
+- support files with missing WINDOW2 record.
+
+- Empty cells are now always unicode strings, they were a bytestring on
+  Python 2 and a unicode string on Python 3.
+
+- Fix for ``<cell>`` ``inlineStr`` attribute without ``<si>`` child.
+
+- Fix for a zoom of ``None`` causing problems on Python 3.
+
+- Fix parsing of bad dimensions.
+
+- Fix xlsx sheet to comments relationship.
+
+Thanks to the following for their contributions to this release:
+
+- Lars-Erik Hannelius
+- Deshi Xiao
+- Stratos Moro
+- Volker Diels-Grabsch
+- John McNamara
+- Ville Skyttä
+- Patrick Fuller
+- Dragon Dave McKee
+- Gunnlaugur Þór Briem
+
+0.9.4 (14 July 2015)
+--------------------
+
+- Automated tests are now run on Python 3.4
+
+- Use ``ElementTree.iter()`` if available, instead of the deprecated
+  ``getiterator()`` when parsing xlsx files.
+
+- Fix #106 : Exception Value: unorderable types: Name() < Name()
+
+- Create row generator expression with Sheet.get_rows()
+
+- Fix for forward slash file separator and lowercase names within xlsx
+  internals.
+
+Thanks to the following for their contributions to this release:
+
+- Corey Farwell
+- Jonathan Kamens
+- Deepak N
+- Brandon R. Stoner
+- John McNamara
+
+0.9.3 (8 Apr 2014)
+------------------
+
+- Github issue #49
+
+- Github issue #64 - skip meaningless chunk of 4 zero bytes between two
+  otherwise-valid BIFF records
+
+- Github issue #61 - fix updating of escapement attribute of Font objects read
+  from workbooks.
+
+- Implemented ``Sheet.visibility`` for xlsx files
+
+- Ignore anchors (``$``) in cell references
+
+- Dropped support for Python 2.5 and earlier, Python 2.6 is now the earliest
+  Python release supported
+
+- Read xlsx merged cell elements.
+
+- Read cell comments in .xlsx files.
+
+- Added xldate_as_datetime() function to convert from Excel
+  serial date/time to datetime.datetime object.
+
+Thanks to the following for their contributions to this release:
+
+- John Machin
+- Caleb Epstein
+- Martin Panter
+- John McNamara
+- Gunnlaugur Þór Briem
+- Stephen Lewis
+
+
+0.9.2 (9 Apr 2013)
+------------------
+
+- Fix some packaging issues that meant docs and examples were missing from the tarball.
+
+- Fixed a small but serious regression that caused problems opening .xlsx files.
... 9951 lines suppressed ...

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-xlrd.git



More information about the Python-modules-commits mailing list