Metadata-Version: 1.1
Name: pyexcel
Version: 0.2.3
Summary: A wrapper library that provides one API to read, manipulate and write data in different excel formats
Home-page: UNKNOWN
Author: C.W.
Author-email: wangc_2011 (at) hotmail.com
License: New BSD
Description: ========================================================
        pyexcel - Let you focus on data, instead of file formats
        ========================================================
        
        .. image:: https://api.travis-ci.org/pyexcel/pyexcel.svg?branch=master
            :target: http://travis-ci.org/pyexcel/pyexcel
        
        .. image:: https://codecov.io/github/pyexcel/pyexcel/coverage.svg?branch=master
            :target: https://codecov.io/github/pyexcel/pyexcel?branch=master
        
        .. image:: https://readthedocs.org/projects/pyexcel/badge/?verssion=latest
            :target: http://pyexcel.readthedocs.org/en/latest/
        
        
        Known constraints
        ==================
        
        Fonts, colors and charts are not supported.
        
        
        Feature Highlights
        ===================
        
        1. One API to handle multiple data sources:
        
           * physical file
           * memory file
           * SQLAlchemy table
           * Django Model
           * Python data stuctures: dictionary, records and array
        2. One application programming interface(API) to read and write data in various excel file formats.
        
        
        Available Plugins
        =================
        
        ================ ========================================
        Plugins          Supported file formats
        ================ ========================================
        `pyexcel-io`_    csv, csvz, tsv, tsvz
        `pyexcel-xls`_   xls, xlsx(r), xlsm(r)
        `pyexcel-xlsx`_  xlsx
        `pyexcel-ods`_   ods (python 2.6, 2.7 only)
        `pyexcel-ods3`_  ods
        `pyexcel-text`_  (write only)json, rst, mediawiki,latex,
                         grid, pipe, orgtbl, plain simple
        ================ ========================================
        
        .. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
        .. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
        .. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
        .. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods
        .. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
        .. _pyexcel-text: https://github.com/pyexcel/pyexcel-text
        
        Installation
        ============
        
        
        Recently, pyexcel(0.2.2+) and its plugins(0.2.0+) started using newer version of setuptools. Please upgrade your setup tools before install latest pyexcel components:
        
        .. code-block:: bash
        
            $ pip install --upgrade setuptools
        
        You can install it via pip:
        
        .. code-block:: bash
        
            $ pip install pyexcel
        
        
        or clone it and install it:
        
        .. code-block:: bash
        
            $ git clone http://github.com/pyexcel/pyexcel.git
            $ cd pyexcel
            $ python setup.py install
        
        Installation of individual plugins , please refer to individual plugin page.
        
        Usage
        ===============
        
        
        JSON
        ------------------
        
        .. code-block:: python
        
            >>> import pyexcel as pe
            >>> an_array = [[1,2]]
            >>> sheet = pe.Sheet(an_array)
            >>> sheet.json
            '{"pyexcel sheet": [[1, 2]]}'
        
        Note: It is available with pyexcel v0.2.1 and pyexcel-text 0.2.0
        
        
        TSV
        ---------------------
        
        .. code-block:: python
        
            >>> sheet.tsv
            '1\t2\r\n'
        
        Note: TSV and the rest of the formats are available with pyexcel v0.2.2 and its plugins at version 0.2.0+ only
        
        
        CSV
        ---------------------
        
        .. code-block:: python
        
            >>> sheet.csv
            '1,2\r\n'
        
        
        Documentation
        =============
        
        Documentation is hosted at `read the docs <https://pyexcel.readthedocs.org/en/latest>`_ and `pyhosted <https://pythonhosted.org/pyexcel/>`_
        
        
        Development guide
        ================================================================================
        
        Development steps for code changes
        
        #. git clone https://github.com/pyexcel/pyexcel.git
        #. cd pyexcel
        #. 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 envrionment, 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 depdent 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
        
        License
        ================================================================================
        
        New BSD License
        
        
        Acknowledgement
        ===============
        
        All great work have done by odf, ezodf(2), xlrd, xlwt, tabulate and other individual developers. This library unites only the data access code.
        
        
        Change log
        ================================================================================
        
        0.2.3 - 11.07.2016
        --------------------------------------------------------------------------------
        
        Updated:
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        
        #. For python 3, do not seek 0 when saving to memory if sys.stdout is passed on.
           Hence, adding support for sys.stdin and sys.stdout.
        
        0.2.2 - 01.06.2016
        --------------------------------------------------------------------------------
        
        Updated:
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        
        #. Explicit imports, no longer needed
        #. Depends on latest setuptools 18.0.1
        #. NotImplementedError will be raised if parameters to core functions are not supported, e.g. get_sheet(cannot_find_me_option="will be thrown out as NotImplementedError")
        
        0.2.1 - 23.04.2016
        --------------------------------------------------------------------------------
        
        Added:
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        
        #. add pyexcel-text file types as attributes of pyexcel.Sheet and pyexcel.Book, related to `issue 31 <https://github.com/pyexcel/pyexcel/issues/31>`__
        #. auto import pyexcel-text if it is pip installed
        
        Updated:
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        
        #. code refactored sources for easy addition of sources.
        #. bug fix `issue 29 <https://github.com/pyexcel/pyexcel/issues/29>`__, Even if the format is a string it is displayed as a float
        #. pyexcel-text is no longer a plugin to pyexcel-io but to pyexcel.sources, see `pyexcel-text issue #22 <https://github.com/pyexcel/pyexcel-text/issues/22>`__
        
        Removed:
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        #. pyexcel.presentation is removed. No longer the internal decorate @outsource is used. related to `issue 31 <https://github.com/pyexcel/pyexcel/issues/31>`_
        
        
        0.2.0 - 17.01.2016
        --------------------------------------------------------------------------------
        
        Updated
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        
        #. adopt pyexcel-io yield key word to return generator as content
        #. pyexcel.save_as and pyexcel.save_book_as get performance imporvements
        
        
Keywords: excel,python,pyexcel,tsv,tsvzcsv,csvz,xls,xlsx,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: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: PyPy
