Metadata-Version: 1.1
Name: pyexcel-ods3
Version: 0.3.2
Summary: A wrapper library to read, manipulate and write data in ods format
Home-page: UNKNOWN
Author: C.W.
Author-email: wangc_2011 (at) hotmail.com
License: New BSD
Description: ================================================================================
        pyexcel-ods3 - Let you focus on data, instead of ods format
        ================================================================================
        
        .. image:: https://api.travis-ci.org/pyexcel/pyexcel-ods3.png
            :target: http://travis-ci.org/pyexcel/pyexcel-ods3
        
        .. image:: https://codecov.io/github/pyexcel/pyexcel-ods3/coverage.png
            :target: https://codecov.io/github/pyexcel/pyexcel-ods3
        
        **pyexcel-ods3** is a tiny wrapper library to read, manipulate and write data in ods
        format. You are likely to use `pyexcel <https://github.com/pyexcel/pyexcel>`__ together
        with this library. `pyexcel-ods <https://github.com/pyexcel/pyexcel-ods>`__ is a sister
        library that depends on GPL licensed odfpy.
        `pyexcel-odsr <https://github.com/pyexcel/pyexcel-odsr>`_ is the other sister library
        that has no external dependency but do ods reading only
        
        Known constraints
        ==================
        
        Fonts, colors and charts are not supported.
        
        Installation
        ================================================================================
        
        You can install it via pip:
        
        .. code-block:: bash
        
            $ pip install pyexcel-ods3
        
        
        or clone it and install it:
        
        .. code-block:: bash
        
            $ git clone http://github.com/pyexcel/pyexcel-ods3.git
            $ cd pyexcel-ods3
            $ python setup.py install
        
        Usage
        ================================================================================
        
        As a standalone library
        --------------------------------------------------------------------------------
        
        Write to an ods file
        ********************************************************************************
        
        
        
        Here's the sample code to write a dictionary to an ods file:
        
        .. code-block:: python
        
            >>> from pyexcel_ods3 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.ods", data)
        
        
        Read from an ods file
        ********************************************************************************
        
        Here's the sample code:
        
        .. code-block:: python
        
            >>> from pyexcel_ods3 import get_data
            >>> data = get_data("your_file.ods")
            >>> import json
            >>> print(json.dumps(data))
            {"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}
        
        
        Write an ods to memory
        ********************************************************************************
        
        Here's the sample code to write a dictionary to an ods file:
        
        .. code-block:: python
        
            >>> from pyexcel_ods3 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 ods from memory
        ********************************************************************************
        
        Continue from previous example:
        
        .. code-block:: python
        
            >>> # This is just an illustration
            >>> # In reality, you might deal with ods file upload
            >>> # where you will read from requests.FILES['YOUR_ODS_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
        ********************************************************************************
        
        Special notice 30/01/2017: due to the constraints of the underlying 3rd party
        library, it will read the whole file before returning the paginated data. So
        at the end of day, the only benefit is less data returned from the reading
        function. No major performance improvement will be seen.
        
        With that said, please install `pyexcel-odsr <https://github.com/pyexcel/pyexcel-odsr>`_
        and it gives better performance in pagination.
        
        Let's assume the following file is a huge ods 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.ods", sheetx)
        
        And let's pretend to read partial data:
        
        .. code-block:: python
        
           >>> partial_data = get_data("huge_file.ods", 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.ods", 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.ods",
           ...     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 ods format,
        installing it is enough.
        
        
        Reading from an ods file
        ********************************************************************************
        
        Here is the sample code:
        
        .. code-block:: python
        
            >>> import pyexcel as pe
            >>> sheet = pe.get_book(file_name="your_file.ods")
            >>> sheet
            Sheet 1:
            +---+---+---+
            | 1 | 2 | 3 |
            +---+---+---+
            | 4 | 5 | 6 |
            +---+---+---+
            Sheet 2:
            +-------+-------+-------+
            | row 1 | row 2 | row 3 |
            +-------+-------+-------+
        
        
        Writing to an ods file
        ********************************************************************************
        
        Here is the sample code:
        
        .. code-block:: python
        
            >>> sheet.save_as("another_file.ods")
        
        
        Reading from a IO instance
        ********************************************************************************
        
        You got to wrap the binary content with stream to get ods working:
        
        .. code-block:: python
        
            >>> # This is just an illustration
            >>> # In reality, you might deal with ods file upload
            >>> # where you will read from requests.FILES['YOUR_ODS_FILE']
            >>> odsfile = "another_file.ods"
            >>> with open(odsfile, "rb") as f:
            ...     content = f.read()
            ...     r = pe.get_book(file_type="ods", 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("ods", 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-ods3.git
        #. cd pyexcel-ods3
        
        Upgrade your setup tools and pip. They are needed for development and testing only:
        
        #. pip install --upgrade setuptools pip
        
        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 steps are
        required:
        
        #. pip install moban
        #. git clone https://github.com/pyexcel/pyexcel-commons.git commons
        #. 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
        
        On Windows systems, please issue this command::
        
            > test.bat
        
        Installation Note
        ================================================================================
        The installation of `lxml` will be tricky on Windows platform. It is recommended that you download a lxml's own windows installer instead of using pip.
        
        
        Change log
        ================================================================================
        
        0.3.2 - 13.04.2017
        --------------------------------------------------------------------------------
        
        Updated
        ********************************************************************************
        
        #. issue `#8 <https://github.com/pyexcel/pyexcel-ods3/issues/8>`_, PT288H00M00S
           is valid duration
        
        0.3.1 - 02.02.2017
        --------------------------------------------------------------------------------
        
        Added
        ********************************************************************************
        
        #. Recognize currency type
        
        0.3.0 - 22.12.2016
        --------------------------------------------------------------------------------
        
        Updated
        ********************************************************************************
        
        #. Code refactoring with pyexcel-io v 0.3.0
        
        0.2.2 - 05.11.2016
        --------------------------------------------------------------------------------
        
        Updated
        ********************************************************************************
        
        #. `#11 <https://github.com/pyexcel/pyexcel-ods3/issues/11>`_, be able to
           consume a generator of two dimensional arrays.
        
        
        0.2.1 - 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.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-ods3' was added so as to inform pyexcel to use it instead
           of other libraries, in the situation where multiple plugins for the same
           file type are installed
        
        
        Updated
        ********************************************************************************
        
        #. support the auto-import feature of pyexcel-io 0.2.0
        
        
        0.1.0 - 17.01.2016
        --------------------------------------------------------------------------------
        
        #. compatibility with pyexcel-io 0.1.0
        
        
Keywords: excel,python,pyexcel,ods
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: 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 :: 3.6
