pypi.org Open in urlscan Pro
2a04:4e42:200::223 Public Scan

Back to summary

URL:
https://pypi.org/project/pyexcel-xls/
Submission Tags: falconsandbox
Submission: On December 06 via api (December 6th 2024, 8:37:44 am UTC) from US — Scanned from IS

Form analysis
3 forms found in the DOM

/search/

<form class="search-form search-form--primary" action="/search/" role="search">
  <label for="search" class="sr-only">Search PyPI</label>
  <input id="search" class="search-form__search" type="text" name="q" placeholder="Search projects" value="" autocomplete="off" autocapitalize="off" spellcheck="false" data-controller="search-focus"
    data-action="keydown@window->search-focus#focusSearchField" data-search-focus-target="searchField">
  <button type="submit" class="search-form__button">
    <i class="fa fa-search" aria-hidden="true"></i>
    <span class="sr-only">Search</span>
  </button>
</form>

/search/

<form class="search-form search-form--fullwidth" action="/search/" role="search">
  <label for="mobile-search" class="sr-only">Search PyPI</label>
  <input id="mobile-search" class="search-form__search" type="text" name="q" placeholder="Search projects" value="" autocomplete="off" autocapitalize="off" spellcheck="false">
  <button type="submit" class="search-form__button">
    <i class="fa fa-search" aria-hidden="true"></i>
    <span class="sr-only">Search</span>
  </button>
</form>

/locale/

<form action="/locale/">
  <ul>
    <li>
      <button class="language-switcher__selected" name="locale_id" value="en" type="submit"> English </button>
    </li>
    <li>
      <button name="locale_id" value="es" type="submit"> español </button>
    </li>
    <li>
      <button name="locale_id" value="fr" type="submit"> français </button>
    </li>
    <li>
      <button name="locale_id" value="ja" type="submit"> 日本語 </button>
    </li>
    <li>
      <button name="locale_id" value="pt_BR" type="submit"> português (Brasil) </button>
    </li>
    <li>
      <button name="locale_id" value="uk" type="submit"> українська </button>
    </li>
    <li>
      <button name="locale_id" value="el" type="submit"> Ελληνικά </button>
    </li>
    <li>
      <button name="locale_id" value="de" type="submit"> Deutsch </button>
    </li>
    <li>
      <button name="locale_id" value="zh_Hans" type="submit"> 中文 (简体) </button>
    </li>
    <li>
      <button name="locale_id" value="zh_Hant" type="submit"> 中文 (繁體) </button>
    </li>
    <li>
      <button name="locale_id" value="ru" type="submit"> русский </button>
    </li>
    <li>
      <button name="locale_id" value="he" type="submit"> עברית </button>
    </li>
    <li>
      <button name="locale_id" value="eo" type="submit"> Esperanto </button>
    </li>
  </ul>
</form>

Text Content

Skip to main content Switch to mobile version
Warning Some features may not work without JavaScript. Please try enabling it if
you encounter problems.



Search PyPI Search
 * Help
 * Sponsors
 * Log in
 * Register

Menu
 * Help
 * Sponsors
 * Log in
 * Register

Search PyPI Search


PYEXCEL-XLS 0.7.0

pip install pyexcel-xls Copy PIP instructions

Latest version

Released: Oct 7, 2021

A wrapper library to read, manipulate and write data in xls format. Itreads xlsx
and xlsm format




NAVIGATION

 * Project description
 * Release history
 * Download files


VERIFIED DETAILS

These details have been verified by PyPI

MAINTAINERS

chfw


UNVERIFIED DETAILS

These details have not been verified by PyPI

PROJECT LINKS

 * Homepage
 * Download

META

 * License: New BSD
 * Author: C.W.
 * Tags python, xls, xlsx, xlsm
 * Requires: Python >=3.6

CLASSIFIERS

 * Intended Audience
   * Developers
 * Programming Language
   * Python
   * Python :: 3 :: Only
   * Python :: 3.6
   * Python :: 3.7
   * Python :: 3.8
   * Python :: Implementation :: PyPy
 * Topic
   * Software Development :: Libraries

Meta is a Visionary sponsor of the Python Software Foundation.
PSF Sponsor · Served ethically

 * Project description
 * Project details
 * Release history
 * Download files


PROJECT DESCRIPTION

pyexcel-xls is a tiny wrapper library to read, manipulate and write data in xls
format and it can read xlsx and xlsm fromat. You are likely to use it with
pyexcel.


OCT 2021 - UPDATE:

1. v0.6.3 removed the pin on xlrd < 2. If you have xlrd >= 2, this library will
NOT read ‘xlsx’ format and you need to install pyexcel-xlsx. Othwise, this
library can use xlrd < 2 to read xlsx format for you. So ‘xlsx’ support in this
library will vary depending on the installed version of xlrd.

2. v0.6.3 can write datetime.timedelta. but when the value is read out, you will
get datetime.datetime. so you as the developer decides what to do with it.


PAST NEWS

detect_merged_cells allows you to spread the same value among all merged cells.
But be aware that this may slow down its reading performance.

skip_hidden_row_and_column allows you to skip hidden rows and columns and is
defaulted to True. It may slow down its reading performance. And it is only
valid for ‘xls’ files. For ‘xlsx’ files, please use pyexcel-xlsx.


WARNING

xls file cannot contain more than 65,000 rows. You are risking the reputation of
yourself/your company/ your country if you keep using xls and are not aware of
its row limit.


SUPPORT THE PROJECT

If your company has embedded pyexcel and its components into a revenue
generating product, please support me on github, patreon or bounty source to
maintain the project and develop it further.

If you are an individual, you are welcome to support me too and for however long
you feel like. As my backer, you will receive early access to pyexcel related
contents.

And your issues will get prioritized if you would like to become my patreon as
pyexcel pro user.

With your financial support, I will be able to invest a little bit more time in
coding, documentation and writing interesting posts.


KNOWN CONSTRAINTS

Fonts, colors and charts are not supported.

Nor to read password protected xls, xlsx and ods files.


INSTALLATION

You can install pyexcel-xls via pip:

$ pip install pyexcel-xls

or clone it and install it:

$ git clone https://github.com/pyexcel/pyexcel-xls.git
$ cd pyexcel-xls
$ python setup.py install


USAGE


AS A STANDALONE LIBRARY

WRITE TO AN XLS FILE

Here’s the sample code to write a dictionary to an xls file:

>>> from pyexcel_xls import save_data
>>> data = OrderedDict() # from collections import OrderedDict
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
>>> data.update({"Sheet 2": [["row 1", "row 2", "row 3"]]})
>>> save_data("your_file.xls", data)

READ FROM AN XLS FILE

Here’s the sample code:

>>> from pyexcel_xls import get_data
>>> data = get_data("your_file.xls")
>>> import json
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}

WRITE AN XLS TO MEMORY

Here’s the sample code to write a dictionary to an xls file:

>>> from pyexcel_xls import save_data
>>> data = OrderedDict()
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
>>> data.update({"Sheet 2": [[7, 8, 9], [10, 11, 12]]})
>>> io = StringIO()
>>> save_data(io, data)
>>> # do something with the io
>>> # In reality, you might give it to your http response
>>> # object for downloading

READ FROM AN XLS FROM MEMORY

Continue from previous example:

>>> # This is just an illustration
>>> # In reality, you might deal with xls file upload
>>> # where you will read from requests.FILES['YOUR_XLS_FILE']
>>> data = get_data(io)
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [[7, 8, 9], [10, 11, 12]]}

PAGINATION FEATURE

Let’s assume the following file is a huge xls file:

>>> huge_data = [
...     [1, 21, 31],
...     [2, 22, 32],
...     [3, 23, 33],
...     [4, 24, 34],
...     [5, 25, 35],
...     [6, 26, 36]
... ]
>>> sheetx = {
...     "huge": huge_data
... }
>>> save_data("huge_file.xls", sheetx)

And let’s pretend to read partial data:

>>> partial_data = get_data("huge_file.xls", start_row=2, row_limit=3)
>>> print(json.dumps(partial_data))
{"huge": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}

And you could as well do the same for columns:

>>> partial_data = get_data("huge_file.xls", start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}

Obvious, you could do both at the same time:

>>> partial_data = get_data("huge_file.xls",
...     start_row=2, row_limit=3,
...     start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[23, 33], [24, 34], [25, 35]]}


AS A PYEXCEL PLUGIN

No longer, explicit import is needed since pyexcel version 0.2.2. Instead, this
library is auto-loaded. So if you want to read data in xls format, installing it
is enough.

READING FROM AN XLS FILE

Here is the sample code:

>>> import pyexcel as pe
>>> sheet = pe.get_book(file_name="your_file.xls")
>>> sheet
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

WRITING TO AN XLS FILE

Here is the sample code:

>>> sheet.save_as("another_file.xls")

READING FROM A IO INSTANCE

You got to wrap the binary content with stream to get xls working:

>>> # This is just an illustration
>>> # In reality, you might deal with xls file upload
>>> # where you will read from requests.FILES['YOUR_XLS_FILE']
>>> xlsfile = "another_file.xls"
>>> with open(xlsfile, "rb") as f:
...     content = f.read()
...     r = pe.get_book(file_type="xls", file_content=content)
...     print(r)
...
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

WRITING TO A STRINGIO INSTANCE

You need to pass a StringIO instance to Writer:

>>> data = [
...     [1, 2, 3],
...     [4, 5, 6]
... ]
>>> io = StringIO()
>>> sheet = pe.Sheet(data)
>>> io = sheet.save_to_memory("xls", io)
>>> # then do something with io
>>> # In reality, you might give it to your http response
>>> # object for downloading


LICENSE

New BSD License


DEVELOPER GUIDE

Development steps for code changes

 1. git clone https://github.com/pyexcel/pyexcel-xls.git

 2. cd pyexcel-xls

Upgrade your setup tools and pip. They are needed for development and testing
only:

 1. pip install –upgrade setuptools pip

Then install relevant development requirements:

 1. pip install -r rnd_requirements.txt # if such a file exists

 2. pip install -r requirements.txt

 3. pip install -r tests/requirements.txt

Once you have finished your changes, please provide test case(s), relevant
documentation and update changelog.yml

Note

As to rnd_requirements.txt, usually, it is created when a dependent library is
not released. Once the dependecy is installed (will be released), the future
version of the dependency in the requirements.txt will be valid.


HOW TO TEST YOUR CONTRIBUTION

Although nose and doctest are both used in code testing, it is adviable that
unit tests are put in tests. doctest is incorporated only to make sure the code
examples in documentation remain valid across different development releases.

On Linux/Unix systems, please launch your tests like this:

$ make

On Windows, please issue this command:

> test.bat


BEFORE YOU COMMIT

Please run:

$ make format

so as to beautify your code otherwise your build may fail your unit test.


KNOWN ISSUES

 * If a zero was typed in a DATE formatted field in xls, you will get
   “01/01/1900”.

 * If a zero was typed in a TIME formatted field in xls, you will get
   “00:00:00”.


3 CONTRIBUTORS

In alphabetical order:

 * John Vandenberg

 * Peter Carnesciali

 * vinraspa


CHANGE LOG


0.7.0 - 07.10.2021

Removed

 1. #46: remove the hard pin on xlrd version < 2.0

Added

 1. #47: limit support to persist datetime.timedelta. see more details in doc


0.6.2 - 12.12.2020

Updated

 1. lock down xlrd version less than version 2.0, because 2.0+ does not support
    xlsx read


0.6.1 - 21.10.2020

Updated

 1. Restrict this library to get installed on python 3.6+, because pyexcel-io
    0.6.0+ supports only python 3.6+.


0.6.0 - 8.10.2020

Updated

 1. New style xlsx plugins, promoted by pyexcel-io v0.6.2.


0.5.9 - 29.08.2020

Added

 1. #35, include tests


0.5.8 - 22.08.2018

Added

 1. pyexcel#151, read cell error as #N/A.


0.5.7 - 15.03.2018

Added

 1. pyexcel#54, Book.datemode attribute of that workbook should be passed
    always.


0.5.6 - 15.03.2018

Added

 1. pyexcel#120, xlwt cannot save a book without any sheet. So, let’s raise an
    exception in this case in order to warn the developers.


0.5.5 - 8.11.2017

Added

 1. #25, detect merged cell in .xls


0.5.4 - 2.11.2017

Added

 1. #24, xlsx format cannot use skip_hidden_row_and_column. please use
    pyexcel-xlsx instead.


0.5.3 - 2.11.2017

Added

 1. #21, skip hidden rows and columns under ‘skip_hidden_row_and_column’ flag.


0.5.2 - 23.10.2017

updated

 1. pyexcel pyexcel#105, remove gease from setup_requires, introduced by 0.5.1.

 2. remove python2.6 test support

 3. update its dependecy on pyexcel-io to 0.5.3


0.5.1 - 20.10.2017

added

 1. pyexcel#103, include LICENSE file in MANIFEST.in, meaning LICENSE file will
    appear in the released tar ball.


0.5.0 - 30.08.2017

Updated

 1. #20, is handled in pyexcel-io

 2. put dependency on pyexcel-io 0.5.0, which uses cStringIO instead of
    StringIO. Hence, there will be performance boost in handling files in
    memory.


0.4.1 - 25.08.2017

Updated

 1. #20, handle unseekable stream given by http response.


0.4.0 - 19.06.2017

Updated

 1. pyexcel-xlsx#15, close file handle

 2. pyexcel-io plugin interface now updated to use lml.


0.3.3 - 30/05/2017

Updated

 1. #18, pass on encoding_override and others to xlrd.


0.3.2 - 18.05.2017

Updated

 1. #16, allow mmap to be passed as file content


0.3.1 - 16.01.2017

Updated

 1. #14, Python 3.6 - cannot use LOCALE flag with a str pattern

 2. fix its dependency on pyexcel-io 0.3.0


0.3.0 - 22.12.2016

Updated

 1. #13, alert on empyty file content

 2. Support pyexcel-io v0.3.0


0.2.3 - 20.09.2016

Updated

 1. #10, To support generator as member of the incoming two dimensional data


0.2.2 - 31.08.2016

Added

 1. support pagination. two pairs: start_row, row_limit and start_column,
    column_limit help you deal with large files.


0.2.1 - 13.07.2016

Added

 1. #9, skip_hidden_sheets is added. By default, hidden sheets are skipped when
    reading all sheets. Reading sheet by name or by index are not affected.


0.2.0 - 01.06.2016

Added

 1. By default, float will be converted to int where fits. auto_detect_int, a
    flag to switch off the autoatic conversion from float to int.

 2. ‘library=pyexcel-xls’ was added so as to inform pyexcel to use it instead of
    other libraries, in the situation where there are more than one plugin for a
    file type, e.g. xlsm

Updated

 1. support the auto-import feature of pyexcel-io 0.2.0

 2. xlwt is now used for python 2 implementation while xlwt-future is used for
    python 3


0.1.0 - 17.01.2016

Added

 1. Passing “streaming=True” to get_data, you will get the two dimensional array
    as a generator

 2. Passing “data=your_generator” to save_data is acceptable too.


PROJECT DETAILS


VERIFIED DETAILS

These details have been verified by PyPI

MAINTAINERS

chfw


UNVERIFIED DETAILS

These details have not been verified by PyPI

PROJECT LINKS

 * Homepage
 * Download

META

 * License: New BSD
 * Author: C.W.
 * Tags python, xls, xlsx, xlsm
 * Requires: Python >=3.6

CLASSIFIERS

 * Intended Audience
   * Developers
 * Programming Language
   * Python
   * Python :: 3 :: Only
   * Python :: 3.6
   * Python :: 3.7
   * Python :: 3.8
   * Python :: Implementation :: PyPy
 * Topic
   * Software Development :: Libraries



RELEASE HISTORY RELEASE NOTIFICATIONS | RSS FEED

This version


0.7.0

Oct 7, 2021

0.6.2

Dec 12, 2020

0.6.1

Oct 21, 2020

0.5.9

Aug 29, 2020

0.5.8

Aug 22, 2018

0.5.7

May 10, 2018

0.5.6

Mar 15, 2018

0.5.5

Dec 8, 2017

0.5.4

Nov 2, 2017

0.5.3

Nov 2, 2017

0.5.2

Oct 23, 2017

0.5.1

Oct 20, 2017

0.5.0

Aug 30, 2017

0.4.1

Aug 25, 2017

0.4.0

Jun 19, 2017

0.3.3

May 30, 2017

0.3.2

May 18, 2017

0.3.1

Jan 16, 2017

0.3.0

Dec 22, 2016

0.2.3

Sep 20, 2016

0.2.2

Aug 31, 2016

0.2.1

Jul 13, 2016

0.2.0

Jun 1, 2016

0.1.0

Jan 17, 2016

0.0.8

Nov 3, 2015

0.0.7

May 21, 2015

0.0.6

Feb 21, 2015

0.0.5

Jan 24, 2015

0.0.4

Jan 9, 2015

0.0.3

Dec 15, 2014

0.0.2

Dec 7, 2014


DOWNLOAD FILES

Download the file for your platform. If you're not sure which to choose, learn
more about installing packages.


SOURCE DISTRIBUTION

pyexcel-xls-0.7.0.tar.gz (53.8 kB view details)

Uploaded Oct 7, 2021 Source


BUILT DISTRIBUTION

pyexcel_xls-0.7.0-py2.py3-none-any.whl (11.7 kB view details)

Uploaded Oct 7, 2021 Python 2 Python 3


FILE DETAILS

Details for the file pyexcel-xls-0.7.0.tar.gz.


FILE METADATA

 * Download URL: pyexcel-xls-0.7.0.tar.gz
 * Upload date: Oct 7, 2021
 * Size: 53.8 kB
 * Tags: Source
 * Uploaded using Trusted Publishing? No
 * Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1
   requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7


FILE HASHES

Hashes for pyexcel-xls-0.7.0.tar.gz Algorithm Hash digest SHA256
5ec606ef8667aafbb0c3fbd8242a7c23bf175ee7c10b08f70799b84fb2db84cb Copy MD5
26dcc128da4981ba2990e237d8949fff Copy BLAKE2b-256
7120a8945b1acc2076b78c3a2319389364f088a75474e07178ac8d9250dd0a48 Copy

See more details on using hashes here.


FILE DETAILS

Details for the file pyexcel_xls-0.7.0-py2.py3-none-any.whl.


FILE METADATA

 * Download URL: pyexcel_xls-0.7.0-py2.py3-none-any.whl
 * Upload date: Oct 7, 2021
 * Size: 11.7 kB
 * Tags: Python 2, Python 3
 * Uploaded using Trusted Publishing? No
 * Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1
   requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7


FILE HASHES

Hashes for pyexcel_xls-0.7.0-py2.py3-none-any.whl Algorithm Hash digest SHA256
31c6652ddc8758428ed59c7f2c34a1173abb8f3c7ebdba6fce051ff6f78b8135 Copy MD5
3c7bf8ea485a03acc80c37f4e7ee75d7 Copy BLAKE2b-256
f1a58150710c764803793d908b5aa818a22f085eb672444a75b16ca040fc003b Copy

See more details on using hashes here.


HELP

 * Installing packages
 * Uploading packages
 * User guide
 * Project name retention
 * FAQs


ABOUT PYPI

 * PyPI Blog
 * Infrastructure dashboard
 * Statistics
 * Logos & trademarks
 * Our sponsors


CONTRIBUTING TO PYPI

 * Bugs and feedback
 * Contribute on GitHub
 * Translate PyPI
 * Sponsor PyPI
 * Development credits


USING PYPI

 * Code of conduct
 * Report security issue
 * Privacy Notice
 * Terms of Use
 * Acceptable Use Policy

--------------------------------------------------------------------------------

Status: All Systems Operational

Developed and maintained by the Python community, for the Python community.
Donate today!

"PyPI", "Python Package Index", and the blocks logos are registered trademarks
of the Python Software Foundation.


© 2024 Python Software Foundation
Site map

Switch to desktop version
 * English
 * español
 * français
 * 日本語
 * português (Brasil)
 * українська
 * Ελληνικά
 * Deutsch
 * 中文 (简体)
 * 中文 (繁體)
 * русский
 * עברית
 * Esperanto

Supported by


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

pypi.org Open in urlscan Pro 2a04:4e42:200::223 Public Scan

Form analysis 3 forms found in the DOM

/search/

/search/

/locale/

Text Content

pypi.org Open in urlscan Pro
2a04:4e42:200::223 Public Scan

Form analysis
3 forms found in the DOM