Metadata-Version: 1.1
Name: pyexcel-xls
Version: 0.2.2
Summary: A wrapper library to read, manipulate and write data in xls format. It reads xlsx and xlsm format
Home-page: UNKNOWN
Author: C.W.
Author-email: wangc_2011 (at) hotmail.com
License: New BSD
Description: ================================================================================
        pyexcel-xls - Let you focus on data, instead of xls format
        ================================================================================
        
        .. image:: https://api.travis-ci.org/pyexcel/pyexcel-xls.png
            :target: http://travis-ci.org/pyexcel/pyexcel-xls
        
        .. image:: https://codecov.io/github/pyexcel/pyexcel-xls/coverage.png
            :target: https://codecov.io/github/pyexcel/pyexcel-xls
        
        **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 <https://github.com/pyexcel/pyexcel>`_.
        
        Known constraints
        ==================
        
        Fonts, colors and charts are not supported.
        
        Installation
        ================================================================================
        
        You can install it via pip:
        
        .. code-block:: bash
        
            $ pip install pyexcel-xls
        
        
        or clone it and install it:
        
        .. code-block:: bash
        
            $ git clone http://github.com/pyexcel/pyexcel-xls.git
            $ cd pyexcel-xls
            $ python setup.py install
        
        Usage
        ================================================================================
        
        As a standalone library
        --------------------------------------------------------------------------------
        
        Write to an xls file
        ********************************************************************************
        
        .. testcode::
           :hide:
        
            >>> import os
            >>> import sys
            >>> if sys.version_info[0] < 3:
            ...     from StringIO import StringIO
            ... else:
            ...     from io import BytesIO as StringIO
            >>> PY2 = sys.version_info[0] == 2
            >>> if PY2 and sys.version_info[1] < 7:
            ...      from ordereddict import OrderedDict
            ... else:
            ...     from collections import OrderedDict
        
        
        Here's the sample code to write a dictionary to an xls file:
        
        .. code-block:: python
        
            >>> 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:
        
        .. code-block:: python
        
            >>> 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:
        
        .. code-block:: python
        
            >>> 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:
        
        .. code-block:: python
        
            >>> # 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:
        
        .. code-block:: python
        
           >>> 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:
        
        .. code-block:: python
        
           >>> 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:
        
        .. code-block:: python
        
           >>> 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:
        
        .. code-block:: python
        
           >>> 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]]}
        
        .. testcode::
           :hide:
        
           >>> os.unlink("huge_file.xls")
        
        
        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.
        
        Any version under pyexcel 0.2.2, you have to keep doing the following:
        
        Import it in your file to enable this plugin:
        
        .. code-block:: python
        
            from pyexcel.ext import xls
        
        Please note only pyexcel version 0.0.4+ support this.
        
        
        Reading from an xls file
        ********************************************************************************
        
        Here is the sample code:
        
        .. code-block:: python
        
            >>> import pyexcel as pe
            >>> # from pyexcel.ext import xls
            >>> 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:
        
        .. code-block:: python
        
            >>> sheet.save_as("another_file.xls")
        
        
        Reading from a IO instance
        ********************************************************************************
        
        You got to wrap the binary content with stream to get xls working:
        
        .. code-block:: python
        
            >>> # 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:
        
        .. code-block:: python
        
            >>> 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
        
        #. git clone https://github.com/pyexcel/pyexcel-xls.git
        #. cd pyexcel-xls
        
        Upgrade your setup tools and pip. They are needed for development and testing only:
        
        #. pip install --upgrade setuptools "pip==7.1" 
        
        Then install relevant development requirements:
        
        #. pip install -r rnd_requirements.txt # if such a file exists
        #. pip install -r requirements.txt
        #. pip install -r tests/requirements.txt
        
        
        In order to update test environment, and documentation, additional setps are
        required:
        
        #. pip install moban
        #. git clone https://github.com/pyexcel/pyexcel-commons.git
        #. make your changes in `.moban.d` directory, then issue command `moban`
        
        What is 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.
        
        What is pyexcel-commons
        ---------------------------------
        
        Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
        
        What is .moban.d
        ---------------------------------
        
        `.moban.d` stores the specific meta data for the library.
        
        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 test
        
        On Windows systems, please issue this command::
        
            > test.bat
        
        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".
        
        .. testcode::
           :hide:
        
           >>> import os
           >>> os.unlink("your_file.xls")
           >>> os.unlink("another_file.xls")
        
        Change log
        ================================================================================
        
        0.2.2 - 31.08.2016
        --------------------------------------------------------------------------------
        
        Added
        ********************************************************************************
        
        #. 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
        ********************************************************************************
        
        #. `#9 <https://github.com/pyexcel/pyexcel-xls/issues/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
        ********************************************************************************
        
        #. 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`.
        #. '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
        ********************************************************************************
        
        #. support the auto-import feature of pyexcel-io 0.2.0
        #. xlwt is now used for python 2 implementation while xlwt-future is used for
           python 3
        
        0.1.0 - 17.01.2016
        --------------------------------------------------------------------------------
        
        Added
        ********************************************************************************
        
        #. Passing "streaming=True" to get_data, you will get the two dimensional array
           as a generator
        #. Passing "data=your_generator" to save_data is acceptable too.
        
        
        
Keywords: excel,python,pyexcel,xls,xlsx,xlsm
Platform: UNKNOWN
Classifier: Topic :: Office/Business
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: PyPy
